In der Sommerprüfung 2016 sind mir leider wieder viele Projektdokumentationen aufgefallen, die den verfügbaren Seitenrahmen (bei uns 15 Seiten) nicht ausgeschöpft haben. Das kann ich nicht nachvollziehen. Deswegen ist es Zeit für einen kurzen Artikel zu diesem Thema.
Vorgaben für die Seitenzahl
Häufig stellen mir Prüflinge die Frage, wie lang ihre Projektdokumentation sein sollte. Die kurze Antwort ist: Frag deine IHK!
Es ist erstaunlich, wie viele Prüflinge es nicht hinbekommen, die grundlegenden Formalien ihrer Projektdokumentation selbst zu recherchieren. Normalerweise hat jede IHK eine Beschreibung der formellen Anforderungen an die Projektarbeit (z.B. das Merkblatt zur Abschlussprüfung der IT-Berufe der IHK Oldenburg). Und die sind auch meist sehr eindeutig. Es wird zum Beispiel zwischen Fließtext, Verzeichnissen und Anhang unterschieden. In vielen Fällen wird sogar explizit eine zu verwendende Schriftgröße oder Schriftart vorgegeben. Und in diesen Vorgaben ist auch fast immer ein Hinweis auf die erlaubte Seitenzahl der Projektdokumentation enthalten.
Als ich 2006 meine Prüfung abgelegt habe, gab es noch keine Einschränkung bezüglich des Umfangs. Daher war meine Dokumentation auch fast 100 Seiten lang. Kein Wunder, dass die IHKen eine Obergrenze eingeführt haben. Denn solche Mammutwerke kann kein Prüfer in der wenigen verfügbaren Zeit korrekt bearbeiten.
Die Seitenangaben, von denen ich bereits gehört habe, liegen häufig zwischen 10 und 20 Seiten. Damit ist nur der Fließtext gemeint. Der Anhang kann wieder recht individuell sein. Bei der IHK Oldenburg ist die Vorgabe 15 Seiten für den Fließtext und 25 Seiten für den Anhang. Andere IHKen machen aber ganz andere Vorgaben. Also informiere dich bei der für dich zuständigen IHK nach den Richtlinien für deine Projektarbeit.
Die Obergrenze
Genau wie bei der Präsentation die bekannten 15 Minuten die Obergrenze darstellen, darfst du in der Projektdokumentation die angegebene Seitenzahl nicht überschreiten. Die Prüfer müssten dir dafür zumindest Punkte abziehen, weil du nicht in der Lage warst, die Vorgaben einzuhalten.
Mehr Text bedeutet nämlich nicht unbedingt mehr Inhalt. Im Gegenteil: Oftmals schwafeln die Prüflinge uninteressantes Zeug vor sich hin oder fügen seitenweise Quelltext an, der nur aus Gettern und Settern besteht. Das liefert keinen Mehrwert, sondern ist nur Füllmaterial.
Die Untergrenze
Nichtsdestotrotz sollst du auch nicht versuchen, so wenig Text wie möglich zu produzieren. Nutze den vorhandenen Rahmen optimal aus. Obwohl die IHK meist nur einen oberen Rahmen für die Seitenzahl vorgibt, ist es nicht sinnvoll, weniger Inhalt abzuliefern. Normalerweise wirst du schon Probleme bekommen, die ganzen Inhalte deines Projekts auf den wenigen verfügbaren Seiten unterzubringen. Wenn du tatsächlich noch leere Seiten in deiner Dokumentation hast, war das Projekt wahrscheinlich nicht umfangreich genug oder du hast nicht alle Möglichkeiten ausgeschöpft, um es zu dokumentieren.
Gehen wir doch einmal kurz ein paar absolut sinnvolle Inhalte von Projektdokumentationen durch:
- Lastenheft
- Pflichtenheft
- Architektur
- Klassen
- Entitäten
- Tabellen
- Prozesse
- Testprotokolle
- Quelltext
- Screenshots
- Entwicklungsprozess
- Zeitplanung
- Kostenplanung
- Amortisationsrechnung
Damit kann man locker die vorgegebene Seitenzahl füllen (die Artefakte gehören natürlich in den Anhang, aber die Beschreibungen dazu sind dein Fließtext). Meine Auszubildenden mussten zum Beispiel immer ihre Anhänge in gekürzter Form beilegen, da die ganzen Artefakte sonst keinen Platz gehabt hätten.
Was wäre wenn?
Und denk auch einfach mal daran, was passiert, wenn du für deine Dokumentation nicht das gewünschte Ergebnis (meistens sehr gut 😉 ) einfährst. Angenommen, du bestehst mit einer 2 und hattest noch zehn Seiten in deiner Dokumentation zur Verfügung. Würdest du dich nicht fragen, ob es mit den 10 Seiten mehr vielleicht doch noch für eine 1 gereicht hätte? Oder noch schlimmer: Was ist, wenn du durchfällst, und noch 20 Seiten Spielraum in der Dokumentation hattest?
Wenn ich als Prüfer eine komplett ausgenutzte Projektdokumentation mit einer vergleiche, die nur die Hälfte an Umfang hat, weiß ich doch schon im Vorfeld, dass die zweite Dokumentationen nicht das gleiche Ergebnis erreichen kann. Es ist einfach nicht möglich, ein komplexes Entwicklungsprojekt mit allen notwendigen Methodiken auf insgesamt 10 Seiten zu dokumentieren (die kürzeste Doku, die ich gelesen habe, hatte 12 Seiten von 40). Du brauchst mehr Platz, allein für die oben genannten Artefakte.
Fazit
Tu dir selbst einen Gefallen und nutze die verfügbare Seitenzahl für deine Projektarbeit komplett aus. Das heißt nicht, dass du die Seiten mit langweiligem Inhalt füllen sollst, sondern dass du deine Arbeit von der besten Seite zeigst und alle Artefakte auflistest. Wenn dein Ziel eine gute Abschlussnote ist, führt kein Weg daran vorbei.
Wie viele Seiten hatte deine Projektdokumentation? Wie viele hätte sie haben dürfen? Hast du den vorgegebenen Rahmen ausgeschöpft?
Weitere Infos zur Projektdokumentation
Du suchst noch mehr Tipps rund um die Projektdokumentation? Dann schau doch mal in diese Artikel- und Podcast-Kategorie: Alle Artikel rund um die Projektdokumentation.
Kennst du schon meine Microsoft Word-/LibreOffice-Vorlage für die Projektdokumentation? Unter dieperfekteprojektdokumentation.de kannst du sie herunterladen.
Und wenn du dich für meinen Newsletter einträgst, kannst du dir jetzt sofort meine Checkliste für die Projektdokumentation herunterladen.
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