Dokumentation von eigenen Programmen

Hallo zusammen,
ich bin grade dabei ein Programm für meinen Arbeitgeber zu schreiben.
& Webseiten mit Javascript…

Der Arbeitgeber wünscht auch eine Dokumentation zu diesem „Programm“, einmal sollte der Aufbau, die Funktionsweise, sowie auch die programmiertechnische Umsetzung beinheltet sein.
Desweiteren ist eine Erläuterung des Quellcodes erwünscht.

Wie geht man am besten bei einer Doku vor, was muss ich beachten etc.
Bsp.: Pflichtenheft, wie ist der Aufbau, was muss enthalten sein?

Bin für jeden Tipp dankbar, Thema ist auch vom provaten interesse

Gruß Marcel

zu Quelltext-Dokumentation
Hi Marcel,

falls du schon einmal mit Java programmiert haben solltest, dann kenst du vielleicht das Tool javadoc, welches aus Kommentaren im Quelltext eine Doku erstellt, die der der Java-Api gleicht.

Für andere Programmiersprachen gibt es da ein Tool namens doxygen, welches ebenfalls kostenlos erhältlich ist.

So kannst du z.B. in deinem Quelltext Kommentare speziell formatieren und doxygen erstellt dir dann eine übersichtliche Doku in HTML, die dann dei Kommentare verarbeitet.

Schau dir mal die doxygen-Page an, da sind einige Beispiele…

Ciao, Bill