Moin Sebastian,
stimmt daran hatte ich gar nicht gedacht.
Nehmen wir also einmal an ich hätte ein Programm (z.B.
einen kleinen Texteditor) als Freelancer für eine Firma programmiert und verkaufe diesen nun mitsamt Quelltext an die Firma. Diese möchte nun das ich eine komplette Dokumentation mitliefere. Spontan fallen mir da folgende Punkte ein:
- ausführliche Beschreibung wie das Programm zu bedienen ist bzw was es überhaupt macht
- UML-Diagramme (kennt jemand eine gute Software dafür, am besten Freeware) & Programmablaufdiagramme
- verwendete Schnittstellen / Bibliotheken / Fremdkomponenten
- Funktionsbeschreibungen und -erklärungen
Sonst noch etwas beim Beispiel Texteditor? Und wie sieht es eigentlich mit kurzen Quelltextkommentaren aus?