Software Engineering, 2nd Edition

12 Dokumentation in der Software-Entwicklung

Many software companies, about to ship a new product or update, realize too late that they’re missing something vitally important – first class documentation.

(Aus der Werbung einer Dokumentationsfirma)

Die Dokumentation gilt als ewiges Sorgenkind der Software-Entwicklung. Sie müsste es nicht sein. In diesem Kapitel klären wir den Dokumentationsbegriff und diskutieren die Bestandteile und die Qualität einer Dokumentation.

12.1 Begriff und Einordnung

Dokumentieren ist eine Daueraufgabe. Das noch immer verbreitete Vorgehen, erst nach Ende der Codierung zu dokumentieren, führt zu schlechter Software-Qualität, denn die Information, die es aufzuzeichnen gilt, ist vergessen oder – mit der Person, die diese ...