Inhalt einer Dokumentation?

[chris_82]

Was gehört in eine ordentliche Dokumentation eines Projektes alles hinein?

[Hansa]

Kommentare des Source. Erklärung aller Units (wo was zu finden ist). Ansonsten kommt es drauf an, wie weit das ganze geht.

[cyberkiller0072001]

Wichtig ist auch immer eine Erklärung wo drinsteht, welche Variablen für was verwendet wurden...

MfG Daniel

[Sanchez]

im Optimalfall sind Variablenbezeichnungen weitgehend selbsterklärend. Genauso wie funktionen.
Ich würde da keine komplette Aufstellung der Variablen machen. Der Ablauf im groben sowie ein detaillierter Ablauf der Units und der wichtigsten Funktionen würd ich für angebracht halten.
Außerdem würd ich die GUI näher erläutern.

grüße, daniel