Seitenzahl der Projektdokumentation

Sinnvolle Anzahl der Seiten der Projektdokumentation

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.

Checkliste für die Projektdokumentation

2 thoughts on “Sinnvolle Anzahl der Seiten der Projektdokumentation

  1. 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. 😉

  2. 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!

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.

To create code blocks or other preformatted text, indent by four spaces:

    This will be displayed in a monospaced font. The first four 
    spaces will be stripped off, but all other whitespace
    will be preserved.
    
    Markdown is turned off in code blocks:
     [This is not a link](http://example.com)

To create not a block, but an inline code span, use backticks:

Here is some inline `code`.

For more help see http://daringfireball.net/projects/markdown/syntax