Wie viel Zeit sollte man für die Projektdokumentation einplanen?

Die Planung der Projektdokumentation ist ein Thema, das immer wieder Fragen aufwirft. Eine davon ist die Frage nach der benötigten Zeit für das Erstellen der Projektdokumentation:

Wie viel Zeit sollte ich für das Erstellen der Projektdokumentation einplanen?

Die kurze Antwort: So viel wie nötig, um eine optimale Dokumentation zu erstellen.

Abgrenzung zur Kunden- und Entwicklerdokumentation

Vorab ein wichtiger Hinweis: Ich spreche hier von der Projektdokumentation, die euer Prüfungsausschuss bewertet. Es geht nicht um die Kunden- und Entwicklerdokumentation, die zusätzlich erstellt werden muss. Sie ist eigentlich in jedem Abschlussprojekt vorhanden und muss auch auf jeden Fall bei der Zeitplanung berücksichtigt werden. Die Kunden- und Entwicklerdokumentation ist Teil der Projektdokumentation, genau wie ein Use-Case-Diagramm oder ein ER-Modell. Üblicherweise werden 2-3 Stunden für die Kunden- und 1 Stunde für die Entwicklerdokumentation (z.B. Generierung auf Basis von JavaDoc) eingeplant.

Zeit für die Projektdokumentation während der Projektlaufzeit

In diesem Artikel habe ich schon einmal gezeigt, dass jede IHK unterschiedliche Vorgaben bzgl. der Zeit für die Erstellung der Projektdokumentation macht, wenn es darum geht, diese Zeit in die gesamte Projektzeit (also die 70 Stunden) einzurechnen: Ist die Projektdokumentation Teil der Bearbeitungszeit des IHK-Abschlussprojekts?

Ob ihr die Projektdokumentation innerhalb der knappen Zeitvorgaben erstellen müsst oder euch beliebig lang Zeit lassen könnt, kann ich also nicht allgemein beantworten. Das müsst ihr im Zweifel eure IHK fragen, um sicher zu gehen.

Zeitplanung im Projekt

Solltet ihr die Projektdokumentation in die 70 Stunden einplanen müssen, rate ich zu einem Wert von ca. 7 bis 8 Stunden, also 10% der Projektlaufzeit. Das ist immerhin ein ganzer Arbeitstag, der nur für die Dokumentation aufgewendet wird.

Kleinere Werte sind nicht realistisch. Ein 10- bis 15-seitiges Dokument mit Anhängen erstellt man nicht mal ebenso. Größere Werte sind allerdings auch nicht sinnvoll, da ihr natürlich nicht den Großteil der Projektzeit für Dokumentation aufwenden soll, anstatt Software zu entwickeln. Dazu passt der Satz aus dem agilen Manifest:

Working software over comprehensive documentation

Wenn die Projektdokumentation nicht innerhalb der 70 Stunden anzufertigen ist, könnt ihr sie natürlich bei der Zeitplanung eures Projekts auslassen, sodass ihr entsprechend mehr Zeit für die eigentliche Projektumsetzung (z.B. Entwurf oder Implementierung) habt.

Realistischer Zeitbedarf

Sind wir mal ganz ehrlich: Wer von uns kann eine 40-seitige Dokumentation inkl. Anhängen (Beispiele: Gerda und Markus) perfekt in 7 Stunden setzen? Ich könnte es wahrscheinlich nicht. Zumindest nicht ohne die richtige Vorbereitung.

Wenn ihr eure Projektdokumentation außerhalb der 70 Stunden schreiben dürft, dann nehmt euch so viel Zeit wie nötig, um eine perfekte Dokumentation abzuliefern. Schaut besser dreimal über die Texte und Grafiken und entfernt auch die letzten kleinen Fehler.

Macht euch noch einmal bewusst, dass die komplette Note für euer Projekt auf Basis der Projektdokumentation vergeben wird. Ob eure Software toll aussieht oder überhaupt läuft, interessiert (leider) niemanden. Im Zweifel solltet ihr also besser mehr Zeit in die Dokumentation als in die Programmierung stecken.

Solltet ihr die Projektdokumentation innerhalb der 70 Stunden umsetzen müssen, dann helfen euch vielleicht die folgenden Tipps dabei, die Zeit einzuhalten.

Wie soll ich eine gute Dokumentation in 7 Stunden schreiben?

Wie gesagt, eine „perfekte“ Dokumentation schreibt man nicht einfach so. Und auch nicht in 7 Stunden.

Allerdings sagt niemand, dass alle Inhalte der Projektdokumentation in diesen 7 Stunden umgesetzt werden müssen. Im Gegenteil, das wäre sogar völliger Unsinn. Denn die meisten Inhalte sind ja Artefakte, die im Projektablauf erstellt wurden und in der Dokumentation „nur noch“ aufgeführt werden.

Niemand erstellt z.B. ein Use-Case-Diagramm in der Dokumentationsphase. Dieses Diagramm wird im normalen Projektablauf in der Analysephase erzeugt. Dafür ist auch entsprechend Zeit bei der Projektplanung zu berücksichtigen. Das Diagramm ist danach natürlich „fertig“ und ihr könnt es später einfach in eure Dokumentation einbetten.

Die 7 Stunden verwendet ihr im Optimalfall also nur noch, um die Dokumentation zusammenzustellen und „rund“ zu machen. Hier nun meine Tipps zum Erstellen der Projektdokumentation unter „Zeitdruck“.

Tipps zum Erstellen der Projektdokumentation

  • Erstellt eure Artefakte komplett in den entsprechenden Projektphasen.
    Ein Use-Case-Diagramm muss z.B. in der Analysephase erstellt werden oder ein Architekturdiagramm in der Entwurfsphase. Diese Artefakte müssen dann anschließend „nur noch“ in die Dokumentation eingebunden werden.
  • Erzeugt Textteile für die Dokumentation schon während der Bearbeitungsphase.
    Anforderungen, Testszenarien, die Projektbegründung usw. sind alles Texte, die im normalen Projektablauf erstellt werden können und müssen, um ein Projekt umzusetzen. Diese Texte können später direkt in der Projektdokumentation wiederverwendet werden. Das gleiche gilt natürlich für eure Quelltexte.
  • Setzt Formatierung und Layout außerhalb der Projektzeit um.
    Niemand sagt, dass ihr in den 7 Stunden ein komplettes Dokument aus dem Nichts erschaffen müsst. Ihr dürft natürlich Vorlagen verwenden. Dadurch spart ihr euch den Aufwand der Formatierung usw.
  • Verwendet ein vernünftiges Textsatzsystem.
    Wenn ihr z.B. LaTeX verwendet, könnt ihr eure Artefakte mit einem einzigen Befehl in die Dokumentation einbinden. Außerdem könnt ihr das Dokument optimal versionieren und somit Stück für Stück während der Projektarbeit erstellen. Verschobene Bilder, die aus unerklärlichen Gründen am Bildschirmrand festhängen und euch Zeit rauben, gehören damit auch der Vergangenheit an.
  • Verwendet meine (LaTeX-)Vorlage für die Projektdokumentation.
    Meine Vorlage Vorlage enthält alle wichtigen Elemente bereits voreingestellt und ihr bekommt „auf Knopfdruck“ ein ansprechendes Layout und perfekten Textsatz. Das ganze Drumherum könnt ihr euch damit sparen. Wie gesagt: Ihr müsst für eure Projektdokumentation das Rad nicht neu erfinden. Vorlagen sind erlaubt! Allerdings muss eure Eigenleistung erkennbar sein. Einfach nur „abschreiben“ ist nicht drin. Das wird jedem halbwegs bewanderten Prüfer sofort auffallen (siehe dazu auch Gliederung der Projektdokumentation (Teil 1))!

Fazit

Die Projektdokumentation ist der zentrale Bestandteil eurer Abschlussnote! 50% von 50% (Teil A) liegen ausschließlich in eurer Hand. Ich würde immer eher zuviel Zeit in die Dokumentation investieren als zu wenig! Alles andere ist einfach dumm.

Selbst wenn ihr die Zeit für die Projektdokumentation innerhalb eurer 70 Stunden einplanen müsst, könnt ihr unter Verwendung einer guten Vorlage und durch Erstellung eurer Artefakte und Teiltexte während der normalen Projektzeit (wo sie ohnehin hingehören) einiges an Zeit rausholen, damit ihr die Projektdokumentation in wenigen Stunden umsetzen könnt.

Wie seht ihr das? Wie viel Zeit plant ihr für eure Projektdokumentation ein? Oder habt ihr sie schon geschrieben? Dann schreibt mir doch, wie viele Stunden ihr dafür gebraucht habt.

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

4 thoughts on “Wie viel Zeit sollte man für die Projektdokumentation einplanen?

  1. Hallo Stefan,
    ich bin der gleichen Meinung. Als ich meine Projektdokumentation geschrieben habe ( inkl. Kunden- und Entwicklerdoku), plante ich 12 Stunden ein. Anfangs dachte ich ,dass es viel zu viele Stunden wären, aber sie war gut investiert. Meine Doku wurde mit 98% bewertet und unterstützt damit Stefans Meinung. 🙂
    Viele Grüße Daniel

  2. Hallo Stefan,
    muss, wenn man deine Vorlage nutzt, das auch als Quelle angegeben werden?
    Viele Grüße und vielen Dank für Deine unheimlich hilfreiche Seite Chris

  3. Hallo Chris,

    das kommt auf die Vorlage an. Bei LaTeX erwarte ich eine Namensnennung im Quelltext (nicht im PDF). Bei der Word-Vorlage erwarte ich nichts. Ob du trotzdem eine Quelle für die IHK angeben musst, kann ich dir leider nicht sagen.

    Viele Grüße!
    Stefan

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