Hi,
du hast eigentlich da Freiheit. Zumindest was das Format angeht. Meistens schreibe ich Dokumentationen in PDF (LaTeX bei mathematischen Sachen oder OpenOffice.org bei anderen Dingen). Allerdings kannst du das ganze auch in Form einer OnlineHilfe schreiben (.chm) oder ein einfaches Worddokument schreiben.
Zu Allen Möglichkeiten findest du in der
DP was entsprechendes.
Der Aufbau sollte - meiner Meinung nach - ungefähr so aussehen:
- Einführung - Was macht dein Progamm? Womit hast du es geschrieben? Was ist der Sinn? etc.
- Dateien - Welche Dateien liegen dem Programm bei? Welche Funktion hat welche Datei? etc.
- Algorithmen - Welches Problem soll das Programm lösen? Welchen Algorithmus hast du verwendet? etc.
- Source-Dokumentation - Welche Funktion macht was? Erkläre den SourceCode! etc. (nur bei OpenSource)
- Abschluss - Quellen der Algorithmen, Dank (
), etc.
Das im
Groben. So sieht's bei mir zumindest meistens aus.
Chris