Um eine sinnvolle Anzahl der Seiten der Projektdokumentation geht es in der neunten Episode der Shorts des IT-Berufe-Podcasts.
Ich würde dir bzgl. der Anzahl der Seiten deiner Projektdokumentation raten, dich immer zuerst an den konkreten Vorgaben deiner IHK zu orientieren, weil Umfang und Regeln je nach IHK unterschiedlich sein können. Die vorgegebene Seitenzahl ist in der Regel eine Obergrenze, die du nicht überschreiten solltest, gleichzeitig solltest du den verfügbaren Platz möglichst mit sinnvollen Inhalten nutzen, weil zu wenig Text meist nicht wegen der Seitenzahl, sondern wegen fehlender Inhalte zum Problem wird. Für mich gilt deshalb: nicht künstlich aufblasen, aber Fließtext und Anhang so gut wie möglich mit bewertbaren, fachlich passenden Inhalten füllen.
Podcast: Play in new window | Download (Duration: 18:32 — 17.1MB)
Abonnieren: Apple Podcasts | Spotify | RSS
Inhalt
TL;DR: Schreib exakt so viele Seiten in deiner Projektdokumentation, wie es deine IHK erlaubt, und nutze den maximalen Umfang möglichst sinnvoll aus, ohne ihn zu überschreiten.
Erst auf die Vorgaben deiner IHK schauen
In Deutschland gibt es viele verschiedene IHKen und sie können bei der Projektdokumentation unterschiedliche Vorgaben haben. Deshalb solltest du dich nicht auf Aussagen aus Social Media oder aus "dem Internet" verlassen, sondern immer die Unterlagen deiner eigenen IHK prüfen.
Typische Unterschiede können sein:
- erlaubte Seitenzahl im Fließtext
- Regelungen zum Anhang
- Umgang mit Verzeichnissen
- Vorgaben zu Schriftgröße und Schriftart
- Pflicht zu Deckblatt oder bestimmten Bestandteilen
Mein Rat ist deshalb: Schau in die Merkblätter, Handreichungen oder Vorgaben deiner IHK und orientiere dich genau daran.
Die Seitenzahl ist normalerweise eine Maximalvorgabe
Die vorgegebene Seitenzahl meist eine Obergrenze. Es geht also nicht darum, die Seiten zwanghaft vollzumachen, sondern darum, nicht darüber zu liegen.
Der Hintergrund dafür ist aus meiner Sicht vor allem organisatorisch und fair:
- Prüfende müssen viele Dokumentationen in begrenzter Zeit lesen
- umfangreiche Dokumentationen sind in der Praxis schwer zu bewerten
- alle Prüflinge sollen unter vergleichbaren Bedingungen bewertet werden
Als typischen Rahmen gibt es meist 10 bis 20 Seiten Fließtext, je nach IHK. Oft gibt es zusätzlich eine eigene Begrenzung für den Anhang.
Ein Beispiel aus Oldenburg:
- 15 Seiten Fließtext maximal
- 25 Seiten Anhang maximal
- Verzeichnisse und bestimmte formale Bestandteile zählen dabei nicht mit
Zu viele Seiten können zu Abzügen führen
Wenn du die maximale Seitenzahl überschreitest, hast du die Vorgaben nicht eingehalten. Ich vergleiche das gerne mit einem Budget, das überschritten wird: Wenn 15 Seiten erlaubt sind, dann sind 16 eben formal zu viel.
Ich sage aber auch:
- wegen einer kleinen Überschreitung fällt man nicht automatisch durch
- die Folgen hängen von Bewertungskriterien und dem jeweiligen Prüfungsausschuss ab
- formale Fehler führen eher zu kleineren Abzügen als zu einem kompletten Duchfallen
Trotzdem bleibt mein Hinweis eindeutig: Überschreite die erlaubte Seitenzahl nicht.
Zu wenige Seiten sind nicht direkt das Problem
Ich betone hier nochmal, dass niemand allein deshalb Punkte abzieht, weil du weniger Seiten abgegeben hast als maximal erlaubt. Eine Dokumentation mit weniger Seiten ist formal erst einmal in Ordnung.
Das eigentliche Problem ist für mich etwas anderes:
- Wenn du deutlich weniger schreibst, fehlen oft wichtige Inhalte.
- Der Punktabzug kommt dann nicht wegen der Seitenzahl, sondern wegen nicht dokumentierter Inhalte.
Mein Beispiel dazu: Wenn ich bei einem Softwareprojekt ein Klassendiagramm erwarten würde und es fehlt, dann ziehe ich dafür Punkte ab. Nicht, weil noch freie Seiten übrig waren, sondern weil ein inhaltlich sinnvoller Bestandteil fehlt.
Mein praktischer Rat: Nutze den verfügbaren Platz aus
Ich empfehle dir, die erlaubte Seitenzahl möglichst vollständig zu nutzen, weil die Wahrscheinlichkeit hoch ist, dass sonst etwas Relevantes fehlt. Das heißt aber ausdrücklich nicht, dass du die Seiten mit beliebigem Material oder KI-generiertem Fülltext aufblasen sollst.
Wichtig ist mir dabei:
- keine inhaltsleeren Wiederholungen
- keine künstlich verlängerten Beschreibungen
- keine sinnlosen Diagramme ohne Aussagekraft
- stattdessen nur Inhalte, die einen fachlichen Mehrwert haben und bewertet werden können
Wie ich auf Seitenzahl und Inhalt schaue
Beim Lesen von Projektdokumentationen betrachte ich Artefakte im Fließtext gedanklich anders als reinen Fließtext. Dazu zähle ich zum Beispiel:
- Abbildungen
- Tabellen
- Diagramme
- Codeschnipsel
- Berechnungen
Wenn mitten im Fließtext viele solcher Elemente stehen, ist das für mich ein Hinweis darauf, dass der eigentliche beschreibende Text kürzer ausfällt. Das führt nicht automatisch zu einem Abzug, aber es kann ein Indiz sein, dass Inhalte eventuell zu knapp dargestellt wurden. Entscheidend bleibt für mich immer der Inhalt, nicht die nackte Seitenzahl.
Was du in eine Projektdokumentation aufnehmen könntest
Hier kommt eine ganze Reihe von Inhalten, die in einem typischen Projekt der Fachinformatiker:innen, besonders in der Anwendungsentwicklung, vorkommen können. Vieles davon gilt auch für andere IT-Berufe.
Anforderungen
- Anforderungsermittlung
- Lastenheft
- Pflichtenheft
- User Storys
- Product Backlog
Architektur und technische Modelle
- Architekturskizzen
- UML-Diagramme
- Klassendiagramme
- Sequenzdiagramme
- Zustandsdiagramme
- Komponentendiagramme
- Deployment-Diagramme
Infrastruktur und Systemdarstellung
- Netzwerkpläne
- Server-Erreichbarkeit
- Ports und technische Zusammenhänge
Datenmodellierung und Schnittstellen
- ER-Modelle
- relationale Tabellenmodelle
- JSON-Strukturen
- OpenAPI-Beschreibungen bei REST-APIs
Prozesse und Abläufe
- dokumentierte oder optimierte Prozesse
- Modellierung mit BPMN
- EPK
- Aktivitätsdiagramme
Umsetzungsnachweise
- Quellcode aus Produktivcode oder Testcode
- Screenshots
- Konfigurationsdateien
- Fotos von umgesetzten Arbeiten
Projektorganisation
- Vorgehensmodell wie Scrum, Wasserfall oder Kanban
- Beschreibung des Entwicklungsprozesses
- Ticket-System
- Code-Review
- Zusammenarbeit mit anderen Beteiligten
- organisatorische Abläufe
Planung und Wirtschaftlichkeit
- Zeitplanung für die 40 bzw. 80 Stunden
- Ressourcenplanung
- detaillierte Tabellen
- Kostenkalkulation
- Amortisationsrechnung
- Gegenüberstellung von Kosten und Einsparpotenzial
Mit dieser Liste will ich zeigen, dass bei einem normalen Projekt schnell viele sinnvolle Inhalte zusammenkommen können und 15 Seiten deshalb durchaus knapp werden können.
Meine abschließende Motivation für dich
Ich gebe dir am Ende noch einen Gedanken mit: Wenn du eine schlechte Note bekommst oder sogar durchfällst, obwohl du noch freie Seiten gehabt hättest, wirst du dich möglicherweise fragen, ob zusätzliche sinnvolle Inhalte den Unterschied gemacht hätten.
Deshalb mein Fazit:
- halte die Maximalvorgabe deiner IHK ein
- überschreite sie nicht
- nutze den verfügbaren Platz aber möglichst aus
- fülle ihn nur mit sinnvollen, bewertbaren Inhalten
Für mich ist genau das der sinnvolle Weg, damit deine Projektdokumentation zeigt, was du in deiner Ausbildung gelernt hast und was du im Projekt tatsächlich geleistet hast.
Links
- Permalink zu dieser Podcast-Episode
- RSS-Feed des Podcasts
- Inhalte der Projektdokumentation
- Gliederung der Projektdokumentation (Teil 1)
Transkription der gesamten Episode
Automatisch erzeugte Transkription der Episode
Heute geht es um ein Thema, was immer wieder für Aufsehen sorgt oder Aufregung auf, vor allem im Internet, gerade bei TikTok, unter meinen letzten Videos, die ich gerade gepostet habe, während ich das hier aufnehme. Und zwar zum Thema Seitenzahlen in der Projektdokumentation bei dem Abschlussprojekt der IT-Berufe. Und ja, Kernfrage, die ich heute beantworten will, ist, wie viele Seiten sollte meine Projektdokumentation haben? Also vor allem Fließtext, aber auch Anhang, wie viele Seiten sind da sinnvoll? Und ich mache mal so ein Too-Long-Din’t-Read zum Einstieg. Wenn du nicht weiterhören willst als hier, schreib einfach genauso viele Seiten voll, wie deine IHK dir erlaubt. Das war’s. Und jetzt kommen wir kurze Erklärungen, warum das so ist. Fangen wir vielleicht mal ganz vorne an. Deine IHK erlaubt dir was? Hä? Ja, denn wir erinnern uns, wir haben in Deutschland 79 verschiedene IHKen. Und die machen für ihre Abschlussprojekte, für die IT-Brufe alle eventuell unterschiedliche Vorgaben. Einige machen auch keine Vorgaben oder haben einfach nichts online oder was auch immer, machen stillschweigend irgendwelche Vorgaben. Aber erstmal ist Fakt, wir haben verschiedene IHK’en und die machen potenziell unterschiedliche Vorgaben, was den Umfang einer Projektdokumentation angeht. Das heißt von, ich glaube, 10 bis 20 Seiten Fließtext habe ich schon verschiedene Vorgaben gesehen.
Einige nehmen den Anhang mit dazu, andere nicht. Verzeichnen es raus oder doch nicht. Und es gibt überall die Möglichkeit für jede IHK, das individuell festzulegen. Es ist nicht deutschlandweit standardmäßig überall gleich. Das schon mal vorweg. Wie bei ganz vielen anderen Sachen auch übrigens zur Abschlusspräsentation und Projektdokumentation. Immer erstmal gucken, was die eigene IHK vorgibt. Weil das kann teilweise sehr krass unterschiedlich sein zu irgendwas, was du irgendwo anders im Internet liest oder gehört hast. Also guck immer, was deine IHK dir vorgibt. Daran musst du dich orientieren und nicht an irgendwas, was du irgendwo mal gehört hast bei TikTok, Instagram oder YouTube. Ja, deine IHK vergibt, nein, die IHK gibt dir nicht die Note, der Prüfungsausschuss gibt dir die Note, aber die orientieren sich natürlich an den Vorgaben der jeweiligen IHK. Also bitte erstmal darauf gucken. Und im einfachsten Fall guckst du auf der Website deine IHK, da gibt es normalerweise Merkblätter, Handreichungen, Vorgaben, was auch immer, zur Projektarbeit in den IT-Berufen. Ja, es gibt Projektarbeiten auch in anderen Berufen. Deswegen guck explizit nach den für deinen Beruf und nicht nach irgendwelchen. Vielleicht gibt es auch nur allgemeine Vorgaben. Also kurz gesagt, guck bei der IHK und recherchiere und find raus, was für deine Projektarbeit gilt. Punkt. Das ist erstmal das Allerwichtigste und daran orientierst du dich.
Und wenn es eine Vorgabe gibt, dann steht da meistens sowas drin wie, wie die Schriftgröße sein soll, die Schriftfamilie, zum Beispiel Areal oder sonst irgendwas, ob es Verzeichnisse geben muss oder nicht, ob es ein Deckblatt geben muss und da gibt es ganz, ganz viele Vorgaben und insbesondere wird dort auch eben oft die Seitenzahl vorgegeben.
Warum? Wenn ich mich an meine Ausbildung erinnere, und die ist jetzt echt lange her. Also ich habe meine Abschlussprüfung gemacht 2006, glaube ich. Also wenn ich das jetzt hier gerade aufnehme, 20 Jahre her. Und damals gab es bei meiner IHKF keine Vorgaben. Und meine Projektdokumentation war über 100 Seiten lang.
Ganz viel Quelltext dran und noch und nöcher Datenverarbeitungskonzept allein, glaube ich, 10 Seiten. Also das war ein Riesending. Und wenn ich mir vorstelle, dass das irgendein Prüfender lesen und bewerten muss in endlicher Zeit, Kostenfrei in seiner Freizeit als Ehrenamt. Das ist echt nicht darstellbar, wenn man dann so wie wir zum Beispiel jetzt in diesem Prüfungsdurchgang über 100 Prüflinge haben. Es ist nicht möglich, das alles noch irgendwie zu stemmen. Deswegen muss man das reduzieren. Es geht also bei diesen Vorgaben nicht darum, dass du diese Seiten füllen musst, sondern es sind eigentlich immer maximal Vorgaben, also maximal 10 Seiten zum Beispiel. Das heißt nicht, dass du die komplett auffüllen musst, aber du darfst nicht drüber liegen, weil dann wird es halt auch irgendwann ein Problem für die Prüfenden und dann wäre es auch unfair, wenn der eine 10 Seiten abgibt, der andere aber 30 und beides ist okay. Ja gut, da kannst du ja ausrechnen, dass bei 30 Seiten irgendwie mehr bei rumkommt als bei 10. Überraschung. Deswegen gibt es immer eigentlich eine Maximalvorgabe und oft liegen die für normalen Fließtext der Projektdokumentation zwischen 10 und 20 Seiten. Vielleicht gibt es auch welche, die noch mehr, noch weniger vorgeben. Dann schreib es mir gerne als Kommentar. Würde mich natürlich interessieren. Ich kenne auch nicht alle 79 IHK-Vorgaben, aber üblicherweise so 10 bis 20 Seiten, davon kann man ausgehen.
Und zusätzlich gibt es dann manchmal oder meistens auch noch weitere Vorgaben für den Anhang. Also hier wird meistens getrennt, Fließtext plus Anhang sind nochmal separate Seiten. Als Beispiel, und daran werde ich mich eigentlich auch immer orientieren jetzt im weiteren Verlauf, bei der IHK Oldenburg, da bin ich ja nun mal prüfender, da haben wir 15 Seiten maximal für den Fließtext plus 25 Seiten maximal für den Anhang. Das heißt insgesamt 40 Seiten für die Projektdokumentation und nicht mit drin sind da dann zum Beispiel noch die Inhaltsverzeichnisse und Tabellenverzeichnisse und alles, was davor halt noch kommt. Und das Deckblatt der IHK und so, das wird alles nicht berechnet. Ab Seite 1, wo du mit der Einleitung startest, 15 Seiten fließt, und danach kommt der Anhang und alles, was da drin ist, dafür hat man 25 Seiten. So, da gehe ich jetzt mal von aus. Andere IHK machen das ähnlich. Wie gesagt, plus, minus, X Seiten, alles möglich.
So, es geht also nicht darum, diese Maximalvorgabe auf Teufel komm raus zu füllen, sondern nur, dass du nicht drüber liegst. Denn wenn du drüber liegst, dann müsste dir ein Prüfender dafür auch einen Punktabzug geben, weil du einfach nicht in der Lage warst, diese Vorgaben einzuhalten.
Wenn man dir sagt, du musst, auch ein beliebtes Beispiel aus einem meiner Videos, du musst für 100 Euro Brötchen kaufen, aber kaufst welche für 110, dann kannst du am Ende nicht sagen, Chef hat aber 110 gekostet. Wenn die Vorgabe, also dein Budget 100 war, dann kannst du nicht 110 ausgeben. Das funktioniert nicht. Und hier ist es genauso, wenn die Prüfungsvorgabe ist maximal 15 Seiten und du gibst 16 ab, dann hast du die Vorgabe nicht eingehalten. Das wäre vergleichbar mit, du hast die Schriftgröße, den Seitenabstand oder was auch immer nicht eingehalten. Dafür muss es halt einen Punktabzug geben. Machen die Prüfer das immer? Wird man bei 15,5 Seiten gleich eine Noteabzug bekommen? Nein, natürlich nicht. Es gibt Bewertungskriterien, Bewertungsmatrizen, wo genau drin steht bei einigen IHK, wofür man wie viele Punkte kriegen kann oder auch nicht kriegen kann. Und für formale oder formelle Gestaltung gibt es bei ganz vielen IHK eine eigene Kategorie und das sind dann vielleicht, weiß ich nicht, 10% der Note. Weil natürlich kommt es bei der Projektdokumentation beim gesamten Projekt auf den Inhalt an und da wird es, wenn überhaupt, einen Abzug für irgendwelche Seitenzahlen oder so geben im unteren Prozentbereich. Da wird man sicherlich nicht eine Note dafür abziehen, wenn du eine Seite zu viel hast. Aber es muss im Vergleich zu jemandem, der die Seitenzahl eingehalten hat, ja irgendwie schlechter bewertet werden. Das ist doch sonst nicht mehr fair den anderen gegenüber, die sich an die Vorgaben gehalten haben. Das kann man ja so nicht machen. Also grundsätzlich abzugsfähig ist das, wenn du zu viele Seiten hast. Heißt das, dass du deswegen sofort durchfällst? Nein.
Könnte man dich dafür durchfallen lassen? Ja, weil du hast die Vorgaben halt nicht eingehalten. Du kannst auch nicht sagen, ich habe 100 Stunden programmiert statt 80 als Anwendungsmeckler und kriegst dafür eine 1. Das funktioniert ja nicht, weil alle anderen haben 80 gebraucht und du 100. Sorry, Vorgaben nicht eingehalten. Also, muss man immer genau gucken, kriegt man jetzt wegen, wie gesagt, einer Zeile mehr eine Note, Punkt, Absatz, oder fällt durch? Eher nicht, aber die Chance ist halt da und theoretisch, formal, könnte man nicht durchfallen lassen dafür. Also, halt die obere Seitenzahl auf jeden Fall ein und schreib nicht mehr als erlaubt. Das wäre schon mal ganz wichtig.
So, jetzt ist aber bei vielen Projektdokumentationen, die ich so lese und gelesen habe in der Vergangenheit, eher das Problem, dass sie zu wenig in Anführungszeichen füllen. Das heißt, in Anführungszeichen, in Anführungszeichen, zu wenig Seiten füllen. So, und zu wenig in Anführungszeichen, weil das ist ja nur eine Maximalvorgabe. Also du könntest auch eine Doku abgeben mit einer Seite, wenn du maximal 15 schreiben darfst. Alles okay. Das Problem, was jetzt nur daraus folgt, ist, wahrscheinlich ist auf der einen Seite nicht der gleiche Inhalt wie in einer anderen Doku mit 15 Seiten. Ich meine, das sollte offensichtlich sein, dass du keine so gute Projektarbeit dokumentieren kannst, wenn du einfach deutlich weniger Text ablieferst. Das funktioniert nicht. Deswegen ist mein Problem mit Dokus, die zu wenig Seiten haben, nicht, dass sie zu wenig Seiten haben, sondern dass einfach Inhalte fehlen, die auf diesen Seiten stehen würden. Und das bringt auch immer ganz viel durcheinander. Oder es ist dann so, wird jetzt hier schon eine Note abgezogen, wenn ich zwei Seiten zu wenig habe? Nein, dafür kriegt niemand eine Note abgezogen. Es ist ja, die Vorgaben sind eingehalten, dafür kann ich dir gar nichts abziehen. Das Problem ist, wenn du Inhalte nicht lieferst, die du aber hättest liefern können auf diesen fehlenden zwei Seiten. Dafür gibt es einen Punktabzug.
Simples Beispiel, ich erwarte bei einer Programmieraufgabe ein Klassendiagramm und du hast keins drin. Dafür aber noch eine Seite frei bis zu deinen 15 erlaubten Seiten. Tut mir leid, dann ziehe ich dir einen Punkt ab, aber nicht für die fehlende Seite, sondern für das fehlende Klassendiagramm. So wird ein Schuh draus. Also kein Prüfender wird dir irgendwie einen Punkt abziehen, weil du zu wenig Text geschrieben hast, sondern es geht immer um den Inhalt, den du nicht geschrieben hast und nicht präsentiert hast. Darum geht es.
Also deswegen allein schon mein Vorschlag, nutz immer die ganze Seitenzahl aus, die du zur Verfügung hast, weil sonst hast du sehr wahrscheinlich irgendwas, was dir fehlt einfach.
So, und bitte verstehe das jetzt nicht so, dass du diese Seiten dann auffüllst mit Schrott, einfach nur, um auf die 15, 10 oder 20 zu kommen. Darum geht es nicht. Und vor allem bitte im Zeitalter von KI, generiere da nicht irgendeinen Schrotttext, nur um die Seiten zu füllen und der wird dann super umfangreich und ausschweifend und 37 Mal wiederholt, sondern du sollst natürlich sinnvolle Inhalte liefern. Also was zu deiner Arbeit beigetragen hast, was du gemacht hast, was bewertet werden kann. Sinnvolle Artefakte, Diagramme, die irgendwie auch einen Mehrwert bringen. Das sollst du da reinpacken und nicht einfach generierten Fließtext, wo du einfach nochmal ein Bild beschreibst, so nach dem Motto. Das ist hier nicht das, was gemacht werden soll, sondern du sollst sinnvolle Inhalte da reinpacken. Und ich habe gleich auch noch eine Liste, die man durchgehen kann für so ein übliches Projekt, bezogen auf Einwilligungsentwicklung, aber viele Inhalte gelten auch für alle anderen IT-Berufe, was man alles so in eine Doku packen könnte, damit du mal einen Eindruck davon hast, warum vielleicht auch 15 Seiten sogar schon knapp werden, wenn man ein entsprechend normales, umfangreiches Projekt hat.
So, ich persönlich mache es tatsächlich so, wenn ich Projektarbeiten jetzt durchlese und korrigiere, dass ich alle Artefakte, die ich irgendwo noch zwischendrin finde in den Fließtextseiten, dass ich die von der Seitenzahl abziehe. Was meine ich mit Artefakten? Also zum Beispiel Abbildung oder Tabellen, Amortisationsrechnung, Code, Schnipsel, was auch immer. Also alles, was kein Fließtext ist, das ist bei mir Artefakte. Und da gehe ich die Doku wirklich durch. Und wenn ich da so eine Seite Klassendiagrammen mitten im Fließtext habe, dann wird das von der Seitenzahl abgezogen. Und dann gucke ich am Ende, oh, sind 13 Seiten gewesen. Okay, daraus folgert ja jetzt noch nicht, dass ich eine Note abziehe oder gar einen Punkt. 13 ist ja kleiner als die erlaubten 15, also passt das alles. Aber das ist für mich nochmal so ein Indiz, wenn ich jetzt sehe, oh, 13 Seiten statt der erlaubten 15, da ist ja die Chance recht hoch, dass irgendetwas fehlt. Und dann gucke ich natürlich nochmal hin, was hätte denn hier noch beschrieben werden können? Ist irgendwas ziemlich knapp oder unverständlich etc.? Und das ist für mich so ein Indiz, um nochmal genauer hinzugucken. Aber bitte nicht falsch verstehen, nur weil jemand 13 Seiten abgibt, mache ich in keinster Weise irgendeinen Punktabzug daran fest, sondern es geht immer um den Inhalt. Punktabzug höchstens, wenn es zu viele Seiten sind. Ich kann mich nur nochmal wiederholen.
So, und jetzt würde ich mal überlegen, wenn du Schwierigkeiten hast, deine 15 oder 10 oder 20 Seiten, also die Vorgaben zu füllen, woran könnte das denn liegen? Vielleicht ist dein Projekt tatsächlich einfach nicht umfangreich genug, sollte eigentlich ausgeschlossen sein, dadurch, dass dein Projektantrag ja genehmigt wurde und Prüfende da schon drauf geguckt haben. Also normalerweise sollten die Projekte umfangreich genug sein, sonst wären sie nicht genehmigt worden. Aber vielleicht hast du ja einfach Sachen vergessen, die zu so einem Projekt üblicherweise dazugehören. Das hattest du aber vielleicht gar nicht auf dem Zettel oder man hat dir das nie gesagt. Und deswegen habe ich mal so ein paar Punkte hier auf der Liste, was du in einem üblichen Projekt für Anwendungsentwicklerinnen durchaus unterbringen könntest. Und gefühlt die Hälfte davon gilt auch für alle anderen IT-Berufe. Ich mache nur mal ein paar Beispiele. Irgendwie musst du Anforderungen erfassen. Was soll überhaupt in einem Projekt gemacht werden? Und das müssen übrigens alle IT-Berufe. Das heißt, es gibt irgendeine Form von Anforderungsermittlung. Sei es zum Beispiel ein Lastenheft, ein Pflichtenheft, User Stories, wie ein Product Backlog, wenn du Bock hast auf Scrum oder was auch immer. Irgendwo schreibst du Anforderungen auf, die kannst du da reinnehmen.
Dann gibt es vielleicht für die Softwareentwicklung Architekturskizzen, UML-Diagramme, Klassendiagramme, Deployment-Diagramme, Komponentendiagramme. Das kann man wunderbar für Softwareentwicklung zeigen. Bei Fizis gibt es da vielleicht einen Netzwerkplan. Wo steht die Firewall, auf welchen Ports ist der Server erreichbar und was auch immer. Dann haben wir natürlich sowas wie Klassendiagramme, wenn du tiefer in den Code rein willst, Sequenz-Diagramme oder Zustandsdiagramme, wenn dein System Zustände hat. Also alles, was die UML hier gibt. Du kannst Datenbanken modellieren mit ER-Modell oder relationalem Tabellenmodell oder eine JSON-Struktur als Open API, wenn es REST API ist, dokumentieren oder modellieren oder was auch immer. Du hast vielleicht irgendwelche Prozesse, die du optimieren willst. Die müssen dokumentiert werden, die müssen vielleicht modelliert werden mit.
BPMN oder einer EPK oder einem Aktivitätsdagramm aus der OML. Du hast, wenn du programmiert hast, irgendwelche Quelltexte von Produktivcode, von Testcode. Du hast Screenshots sicherlich. Du hast vielleicht Config-Files, wo du was angepackt hast. Du hast, weiß ich nicht, am Ende ein Foto gemacht von der Appliance-Firewall, die du in den Server-Rack eingebaut hast. Was auch immer du als Projekt gemacht hast. Also irgendwelche Nachweise, dass du es auch wirklich getan hast. Fotos, Screenshots, wie auch immer. Du hast irgendeine Form von Projektmanagement gemacht, einen Entwicklungsprozess, vielleicht hast du Scrum gemacht oder Wasserfall oder Kanban oder was auch immer, aber auch dazu kannst du Inhalte liefern, vielleicht ein Foto vom Kanban-Board, vielleicht einfach eine Beschreibung des Prozesses, wie ihr mit eurem Ticketsystem arbeitet, wer bei dir einen Code-Review gemacht hat, mit wem du zusammen den Server installiert hast, wer deine Rechnung freigegeben hat, was auch immer, irgendwas, was zum Organatorischen dazugehört.
Und ganz sicher hast du in jedem Projekt, egal welcher IT-Beruf, eine Zeitplanung gemacht. Du hast deine 40 oder 80 Stunden aufgeteilt. Du hast eine detaillierte Aufnahme der nötigen Ressourcen gemacht. Du hast die Zeiten runtergebrochen mit einem schön ausgearbeiteten Plan in einer Tabelle, die du irgendwo unterbringen kannst. Und natürlich hast du auch deine Kosten kalkuliert und eine Amortisationsrechnung gemacht. Mit Kosten versus Einsparungspotenzial und ich weiß nicht was. Ein schönes Diagramm mit so einer Amortisationsrechnung, wo sich irgendwo die Linien dann kreuzen und so weiter. Also alles das sind schon mal Themen, die mir so spontan einfallen, die quasi in jedem Projekt untergebracht werden können. Und dann siehst du vielleicht, oh, da könnten 15 Seiten aber ja tatsächlich schon mal knapp werden, wenn du zu allem auch noch ein bisschen was schreibst, anstatt einfach nur das Artefakt einzubauen.
So, und ich glaube, das war es jetzt von mir als letzte Motivation, nochmal darüber nachzudenken, die Seiten zu füllen. Was wäre, wenn du jetzt eine schlechte Note bekommst oder vielleicht sogar durchfällst in deiner Projektarbeit und hättest am Ende aber noch Platz gehabt, um was zu schreiben? Du hättest also noch Seiten übrig. Du hattest 15 als Vorgabe, hast nur 10 gefüllt und jetzt fällst du durch die Prüfung. Was wirst du dich dann dein Leben lang oder vielleicht auch nur bis zur nächsten Prüfung in einem halben Jahr fragen? Hätte ich es geschafft, wenn ich noch die fünf Seiten gefüllt hätte? Wenn ich hier noch den einen Text hinzugefügt hätte, dieses eine Testprotokoll, das eine Klassendiagramm, hätte ich dann vielleicht bestanden?
Du weißt es nicht. Du hättest es vielleicht geschafft, aber du hast es leider nicht genutzt. Die Inhalte fehlen jetzt nun mal und deswegen bist du vielleicht durchgefallen oder hast eine schlechte Note. Und das wäre doch blöd, weil du nutzt ja diese Chance, die du hast, selber nicht. Niemand sitzt neben dir und guckt dir über die Schulter, während du das Ding hier schreibst, die Doku. Das ist alles in deiner Hand. Du kannst dir das Thema ausdenken, du kannst die Struktur, die Inhalte, das kannst du alles völlig frei gestalten und hast dafür auch im Vergleich zu so einer schriftlichen Prüfung relativ viel Zeit. Also nutzt sie doch auch aus. Du hast alles in deiner Hand. Das heißt aber auch, wenn du durchfällst und eine schlechte Note kriegst, ist niemand anderes außer dir dafür verantwortlich. Und wenn du dein Potenzial, was du hast, in diesem Fall die Seiten, nicht ausnutzt, ja, dann bist du am Ende leider selber schuld, wenn du die Inhalte nicht lieferst, obwohl du sie hättest liefern können. Also, das nochmal die letzte Motivation. Wäre doch blöd, wenn du eine schlechte Note hast und fragst dich dann dein Leben lang, hat es daran gelegen, dass ich noch zwei Seiten hätte schreiben können? Vielleicht hätte das ja den Ausschlag gegeben für die bessere Note. Also, Fazit für heute. Nutze die Seitenzahl, die du ausnutzen darfst, voll aus.
Überziehe nicht, aber nutze es so weit es eben geht aus, die Seitenzahlen für Fließtext und Anhang. Aber fülle das bitte nur mit sinnvollen Inhalten. Füll das nicht mit irgendwelchen inhaltsleeren generierten Kram oder irgendwelchen, habe ich auch schon zum Beispiel gesehen, Klassendiagrammen mit zwei Klassen drauf. Das ist jetzt nicht übertrieben. Die füllen dann eine ganze Seite mit zwei Klassen. Das ist ein bisschen wenig. Das ist ein bisschen inhaltsleer. Das ist auch nicht spannend oder interessant und zeigt auch nicht deine tolle Leistung nach drei Jahren Ausbildung, sondern das ist so, ich musste hier halt irgendwas malen, weil ich muss ja auf die Seitenzahl kommen. Bitte so nicht verstehen, das meine ich nicht. Füll die Dokumentation mit sinnvollen Inhalten, die ich als Prüfender auch bewerten kann, wo ich dir eine Note für geben kann. Die zeigt, dass du deinen Job beherrschst. Darum geht es in dieser Abschlussprüfung.
Das war’s für heute. Ich wünsche dir viel Erfolg bei deiner Dokumentation und hoffe, dass du deine Seitenvorgabe auch einhältst und mit sinnvollen Inhalten füllst. Mach’s gut!









Ich muss sagen, eine maximale Anzahl von 25 Seiten als Anhang wäre mir deutlich zu wenig – Respekt wer mit so wenig Platz auskommt!
Ich bin derzeit an der IHK Köln und meine Projektarbeit umfasst 15 Seiten Bericht plus Anhang. Insgesamt komme ich da auf 110-120 Seiten. (Respekt an die Prüfer, die das lesen müssen!) Eine Vorgabe bezüglich des Anhangs haben wir nicht.
Meiner Meinung nach hat jemand, der die angegebene Seitenzahl nicht ausfüllt schlichtweg das falsche Projekt gewählt oder keinen blassen Schimmer, was genau er da tut. 😉
Das sehe ich auch so: Zu viel Platz kann man eigentlich gar nicht haben! 🙂
Allerdings kenne ich ja auch die „Gegenseite“ und 120 Seiten zu korrigieren ist einfach zeitlich gar nicht möglich. Die Prüfer arbeiten alle ehrenamtlich und ich kann mir nicht vorstellen, dass solche Dokumentationen komplett gelesen und „korrigiert“ werden. Zumal wenn man bedenkt, dass man als Prüfer nicht nur eine Arbeit lesen muss!
Wie viel Zeit hat denn ein Prüfer im Durchschnitt pro Doku?
Hallo Lukas,
dazu gibt es keine Vorgaben. Jeder nimmt sich die Zeit, die er braucht, um die Doku vernünftig bewerten zu können. Das läuft ja alles ehrenamtlich in unserer Freizeit! Wenn man ein wenig geübt ist, kann man „normale“ Dokus in ca. 1h lesen, aber Dokus mit 50+ Seiten sind natürlich eine ganz andere Hausnummer. Die benötigte Zeit ist also sehr individuell vom Prüfer und der Doku abhängig.
Viele Grüße!
Stefan
Ich schreibe auch gerade meinen Projektbericht (ist zwar ein ITSE-Projekt und kein FI-SI/-AE) und muss sagen, dass ich eindeutig zu wenig Seiten zur Verfügung stehen habe. Bei meiner IHK sind es 10 Seiten Text und 15 Seiten Anhang. Für manch einen mag das hilfreich sein, weil das Projekt nicht ganz so üppig ausgefallen ist, aber ich muss da schon einiges herausstreichen.
Hallo Thomas, ja, so unterschiedlich sind die IHKen. Das ist echt doof :-/
Ich habe ein ähnliches Problem, bei uns sind es 20 Seiten insgesamt, also Dokumentation inkl. Anhang ohne eine getrennte Angabe. Dies macht es auch deutlich schwieriger die eigene Arbeit mit den tollen Beispielen aus dem Internet zu vergleichen.
Da die Anhänge ja meistens auch viel Platz benötigen (z.b. umfangreiche Klassendiagramme und Code-Ausschnitte, mache FI-AE) muss man sich schon ganz genau überlegen was man reinbringt. Ein seitenfüllendes Diagramm nimmt einem eine Seite weg, die man auch mit Text füllen könnte.
Bin mir auch sehr unsicher, auf welches Verhältnis von Dokumentation zu Anhang man hierbei am besten kommen sollte, ich peile momentan 10 Seiten Doku und 10 Seiten Anhang an.
Hallo, ich habe mal ein etwas anderes Problem ich komme aktuell nur auf 11. Seiten. von 15 habe mein Anhang, randvoll. Macht es Sinn nun Code Auschnitt in dem Implementierungsabschnitt darzustellen oder sollte ich es im Anhang lassen. Das Problem bei mir liegt glaube, daran dass mein Projekt nicht sehr gut gewählt wurde… 🙁
Hallo Hans, nein, das würde ich nicht tun. Füll deine Fließtext-Seiten nicht mit Artefakten auf. Fülle sie lieber mit Fließtext zu deinem Projekt auf! Auf dieser Website findest du viele Beispiele für Dokumentationen, bei denen du dir vielleicht noch etwas „abschauen“ kannst (natürlich nicht wortwörtlich!).
Ich kann dir leider nicht zustimmen. Viele Lehrlinge entscheiden sich für eine Ausbildung, um sich hohle Worte und Geschwafel, wie du es selbst passen nennst, nicht geben zu müssen – im Gegensatz zum Universitätssystem.
Dass ihnen am Ende dann doch diese Hürde einer „Abschlussarbeit“ in den Weg gelegt wird, ist eine Farce. Da werden mmn Gegebenheiten aus der akademischen Welt blind imitiert, statt die Stärken einer praktischen Ausbildung richtig auszuspielen. Ein Abschlussprojekt ist zwar schön und gut. Aber es sollte funktionieren und der Lehrling ein paar Fragen dazu beantworten können, mehr nicht. Dazu eine handvoll Seiten Handreichung an den Prüfer dass er sich reindenken kann. Jedenfalls keine Abschlussarbeiten die zunehmend auch mit „Quellenverzeichnis“ und anderem Formalismus kommen, was ja schon reichlich absurd ist. Wer möchte soll sowas schreiben, aber für den modalen Fachinformatiker sollte es nicht Pflicht sein.
Hallo Timur, ob du die Abschlussarbeit gut oder schlecht findest, ist leider für die Prüflinge da draußen irrelevant. Denn die Prüfungsordnung ist nunmal wie sie ist und es ist nicht sinnvoll, sich darüber aufzuregen. Stattdessen würde ich empfehlen, die wertvolle Zeit in die bestmögliche Prüfungsleistung zu stecken. Und dafür gilt weiterhin meine obige Empfehlung.
Sollte die IHK, die für die Projektarbeit ein bestimmtes Stundenkontingent vorgibt, von dem nur 20% für die Dokumentation genutzt werden dürfen, nicht ihre Anforderungen an diese Dokumentation entsprechend der verfügbaren Zeit anpassen? Wenn jemand eine 100-seitige Projektdokumentation verfasst, die alle möglichen UML-Diagramme enthält und zudem noch mit LaTeX erstellt wurde, kann er sich unmöglich an die zeitlichen Vorgaben gehalten haben. Ich vermute, dass der ein oder andere Betrieb möglicherweise ein Problem damit hat, wenn sich der Auszubildende drei Monate lang nur mit der Dokumentation seiner Projektarbeit beschäftigt. Folglich bewertet die IHK an dieser Stelle nicht nur die Auszubildenden, sondern auch ihre Unternehmen. Aus meiner Sicht handelt es sich hierbei um Diskriminierung.
Meiner Meinung nach beziehen sich die 20% für die Dokumentation (die übrigens nicht einheitlich bei allen IHKen so vorgegeben sind) nicht auf die Projektdokumentation, sondern auf die im Projekt zu erstellenden Kunden-/Admin-/Entwickler-/API-Dokumentationen. Daher kannst du für die Doku so viel Zeit aufwenden, wie du magst. Siehe auch hier: Ist die Projektdokumentation Teil der Bearbeitungszeit des IHK-Abschlussprojekts?
Und ein vernünftiges Ausbildungsunternehmen unterstützt seine Azubis bei der Prüfungsvorbereitung und insb. der Projektdurchführung. Das ist sein Job! Daher Augen auf bei der Wahl des Betriebs! Siehe auch: Wie du ein gutes/schlechtes Ausbildungsunternehmen erkennst