|
6. Dokumentation
Der Zweck einer Dokumentation ist es, Zeit zu sparen und Fehler zu reduzieren. Man verwendet eine Dokumentation üblicherweise zu zwei Zwecken. Erstens, lesen Leute die Dokumentation, um herauszufinden, wie man den Quelltext verwenden kann. Sie werden z.B. Prozedurköpfe lesen, um zu erfahren, wie eine Prozedur aufgerufen werden kann. Idealerweise sollten die Leute so wenig wie möglich über den Quelltext lernen müssen, um ihn einsetzen zu können. Zweitens, werden Leute die Dokumentation lesen, um herauszufinden, wie der Quelltext intern funktioniert, so daß sie eigenständig Fehler korrigieren oder neue Funktionen hinzufügen können; nochmals, eine gute Dokumentation erlaubt es dem Leser Fehler zu beheben oder Erweiterungen einzupflegen, ohne allzuviel über den bestehenden Quelltext lernen zu müssen. Zu viel Dokumentation ist nicht nötigerweise besser: sich durch viele Seiten Dokumentation kämpfen, ist nicht einfacher als den Quelltext zu entziffern. Versuche die wichtigsten Teile hervorzuheben, die anderen helfen werden, den Quelltext zu verstehen und hebe diese in der Dokumentation hervor.
|