Empfehlungen

Einführung

Selbstverständlich sollte alles dokumentiert werden bevor daran gearbeitet wird. In der Praxis erlebt man dies - trotz vieler Tools - leider häufig nicht. Nachstehend möchte ich Ihnen einige Empfehlungen - im Sinn von Mindestanforderungen - zur Entwicklungsdokumentation geben. Hierbei geht es nicht um die rein technisch vollständige Dokumentation sondern um diejenige Dokumentation, welche aus Sicht der Entwicklung für eine konsistente Entwicklung und spätere Wartung notwendig ist.

Was	Häufigkeit
Klassendiagramm	Immer! Klassendiagramme sollten immer erstellt und aktuell gehalten werden. Klassen stellen die Grundelemente objektorientierter Systeme dar; entsprechend wichtig sind die zugehörigen Dokumentationen.
Zustandsdiagramm	Ich empfehle, für jede Klasse, Komponente, o.ä. mit fünf oder mehr verschiedenen Zuständen ein Zustandsdiagramm zu erstellen bzw. bei Aenderungen nachzuführen.
Sequzendiagramme	Ich empfehle, bei Abläufen, welche mehr als zwei Klassen betreffen Sequenzdiagramme zu erstellen. Diese müssen nicht unbedingt auf tiefster technischer Ebene angesiedelt werden. Häufig reicht es auch aus, ein Sequenzdiagramm auf einer logisch höher angesiedelten Ebene zu erstellen.

Und nochmals: Sie fahren wesentlich besser, wenn sie die vorgenannten Dokumentationen vor einer allfälligen Codierung erstellen und nicht im Nachhinein.