Geplante Dokumentation

[Matthes]

Hallo,

was genau meint ihr sollte bei der geplanten Dokumentation im Projektbericht angegeben werden?

Ich bin FIAE und werde ein Stück Software erstellen.

Also Sachen wie:

-Kommenierter Quellcode und

-Screenshots der Oberfläche

leuchtet mir ja ein.

Aber muss ich da im Vorfeld die gesamte Dokumentation schon planen, oder kann dann in meiner Doku der ein oder andere vorher nicht angegebene Punkt noch dazukommen? :confused:

[CyberDemon]

Original geschrieben von Matthes

[...] oder kann dann in meiner Doku der ein oder andere vorher nicht angegebene Punkt noch dazukommen?

Solche Sachen gibt man unter dem Punkt "Änderungen / Erweiterungen zum Projektantrag" an.

In meinem Fall war das eine Programmerweiterung, die ich im Antrag nicht aufgeführt hatte. Gab keinen Punktabzug.

[Gast roaxius]

Eine Dokumentation ist fast immer gleich aufgebaut:

- Einleitung / Auftragsbeschreibung

- Ist-Zustand

- Soll-Konzept

- Realisierung

- Test

- Abnahme

Die Punkte werden im Projektantrag genannt und mit Unterpunkten gefüllt. Also etwas genauer, was du dokumentieren willst.

Wenn du diese Gliederung dann in der Doku, die du bei der Durchführung schreibst, ein bißchen umstrukturierst hat sicherlich keiner was dagegen. Das habe ich auch gemacht. Du solltest es nur kurz unter "Änderungen gegenüber dem Projektantrag" nennen.

Dazu machst du noch einen Anhang, in den dann die Sachen kommen, die du in deinem Posting genannt hast.

[Matthes]

Besten Dank für die Antworten.

Dann frickel ich das da noch mal irgendwie rein und hoffe mal, dass mein Antrag genehmigt wird.