Professionelle Software-Dokumentation

[Phoenix]

Zitat von Balu der Bär:

Was genau gehört also alles in so einen Dokumentation herein?

Das hängt Prinzipiell erstmal davon ab, für Was Du eigentlich dokumentierst.

Erstellst Du z.B. eine Programm-Bibliothek, dann sollten alle exportierten Funktionen mit sämtlichen Parametern dokumentiert werden. Eine Doku-Erzeugung aus dem Quellcode heraus (XML-Doc) bietet sich für sowas natürlich ideal an.

Brauchst Du eine Doku für Anwender interessieren die einzelnen Methoden niemanden. Die wollen/brauchen die Screenshots aller Formulare, einen Überblick über die Menüstruktur, eine Art 'HowTo': Wenn ich DAS machen will, welches Menü muss ich aufrufen, und wo muss ich was eingeben?

Brauchst Du eine Doku für Dich / Dein Entwicklunsgteam brauchst Du weder 1. (die im Team können bei sowas zur Not im Source nachgucken), und 2. auch nicht. Da brauchst Du einen gesamtüberblick - also gutes ERD für die Datenbank mit allen Relationen etc., UML-Diagramme über die verwendeten gemeinsamen Klassen, Ablaufdiagramme wo nötig, Use-Cases sind hier manchmal sehr informativ.

Wie Du siehst hängt das also von mehreren Sachen ab. So eine pauschale Antwort kann Dir deswegen niemand geben.