Fachkonzept - Dokumentation

Warum dokumentieren?

Dokumentation erfolgt mit dem Ziel, Information über Maßnahmen, Entscheidungen, Ergebnisse eines Software-Entwicklungsprozesses bereitzustellen.

Diese Information ist für die Software-Entwickler von entscheidender Bedeutung. Je komplexer das zu entwickelnde System ist und je mehr Personen daran beteiligt sind, desto schwieriger wird es, alle Details des Software-Entwicklungsprozesses zu überblicken. Dokumentation hilft hier, wichtige Informationen für alle Beteiligten zum Nachschauen bereitzustellen.

Was dokumentieren?

Dokumentation sollte stets parallel zum Entwicklungsprozess erfolgen. Während der einzelnen Entwicklungsphasen sollten alle wichtigen konzeptionellen Entscheidungen festgehalten werden:

• In der Anforderungsanalysephase wird ein Lastenheft erstellt und evtl. ein Prototyp bereitgestellt.
• In der Modellierungsphase werden die entwickelten Modelle möglichst genau beschrieben.
• Die Implementierungsphase liefert ein kommentiertes Programm.
• In der Testphase werden sämtliche untersuchten Testfälle angegeben.