Was gehört alles in eine Softwaredokumentation?

[internet]

Hallo,
bisher habe ich nichts brauchbares auf diese Frage gefunden.
Ich habe meine erste Software geschrieben (Anlegen von Vorgängen, Benutzerverwaltung, Personenverwaltung etc.).

Was gehört alles in eine ordentliche Dokumentation?
Bisher habe ich die Anforderungen (Lastenheft) und ein paar Workflows abgebildet.
Sollte ich jede Methode kurz beschreiben was sie macht?
Nähere Infos sieht man ja dann im Code.

- Ein Inhaltsverzeichnis
- Wie man Erweiterungen im Code hinzufügt
-.....

Gibt es irgendwo vllt auch sogar eine Vorlage?
MfG

 

[XHelp]

Kommt drauf an für wen die Dokumentation ist.
Da können Theoriehintergründe rein
Da kann auch Benutzer sich von der Software rein (Benutzerhandbuch)
Da können bestimmte Codestellen näher erklärt werden oder du machst alles über UML
Interfaces können beschrieben werden
und und und
Kommt wie gesagt drauf an, wer die Doku lesen wird.

 

[internet]

... der "Auftraggeber"

 

[XHelp]

Dann klär es doch mit ihm ab, was genau er sich da vorstellt.

 

[bygones]

Sollte ich jede Methode kurz beschreiben was sie macht?
Nähere Infos sieht man ja dann im Code.

den Kunden interessiert der Code ?

Ansonsten auf jeden Fall NICHT jede Methode beschreiben. Wenn dann nur die API beschreiben