Was gehört alles in eine richtige Dokumentation?

[MaBuSE]

Zitat von Back2Code:

Komplette Software, soll für andere Entwicklerkollegen / Projektmanager sein.

Wie haben hier im Haus 4 Arten von Dokumentationen für jedes Projekt.

1. Benutzerhandbuch für Endanwender
   Viel Prosa und Grafiken, damit sich auch neue Anwender schnell zurechtfinden.
   Es werden die typischen Arbeitsabläufe beschrieben und in einem Referenzkapitel alle Funktionen / Formulare.
2. Systemdokumentation für Entwickler / Support
   Zur Systemdokumentation gehören auch die Dokumente vor der Programmierung (z.B. Pflichtenheft, Anforderungen, Änderungsanforderungen, ...)
   Ein Teil der System-Dokumentation ist ein PDF das aus den Kommentaren des Quelltextes generiert wird (mit Doc-o-matic). Das ist vor allem wichtig, wenn bestimmte Units auch von anderen Programmen benutzt werden.
   Auch zählen Klassendiagramme, Ablaufdiagramme, Unit-Abhänigkeiten usw. dazu.
   Die System Dokumentation sind bei uns mehrere Dokumente.
   Es macht keinen Sinn das alles in ein PDF zu zwängen.
3. Changehistory
   Jede Änderung wird in Releasenotes festgehalten. Die Releasenotes sind in Prosa und für den Endanwender geschrieben. Jedes Mal, wenn eine neue Version in Produktion gegeben wird, wird die Releasenote um die Änderungen zu Vorversion ergänzt.
   Für die Entwickler gibt es eine eigene Historie. Diese besteht aus den Commit Kommentaren unserer Versionsverwaltung (ClearCase bzw. git).
4. Sonstige
   Es gibt immer mal Dokumente, die in keine der oberen Kategorien passen, die wandern in den misc Ordner

Ich hoffe das hilft Dir.
MaBuSE