Und wo ist die Dokumentation?

Das Thema Softwaredokumentation ist kein leichtes - oft fragt man sich am Ende des Projektes, welche Dokumentation eigentlich beauftragt war und nun zu liefern ist. Damit das nicht passieren kann, habe ich vor einiger Zeit einen Projektauftrag für Softwaredokumentation erstellt. Dieser ist in der Projektstartphase gemeinsam mit dem Kunden auszufüllen und formal zu bestätigen (z.B. durch Unterschrift oder Commitment-Abgabe). Man beachte, dass z.B. ein Pflichtenheft nicht verpflichtend zu erstellen und zu liefern ist - in kleineren Projekten kann das Pflichtenheft aus einer Reihe von Einträgen (z.B. User Stories) in einem Issue Management Tool bestehen. Den QS-Plan samt Testdokumentation würde ich aus heutiger Sicht aber in den verpflichtenden Teil aufnehmen. Vielleicht findet Ihr die Idee ja nett und könnt das Template verwenden bzw. ergänzen - ich bin sicher, es gibt noch ganz viele andere Arten von Dokumentation...

Projektname
Projektcode
Mandatorisch
	Projekthandbuch (IPMA konform, Ausfüllungsgrad je nach Projektgröße)
	Technische Spezifikation
	Source Code Kommentare
	Entwickler Javadoc
Optional
	Pflichtenheft
	Requirementsspezifikation
	Dokumentation der Machbarkeitsstudie
	Architekturspezifikation
	Designspezifikation
	GUI Spezifikation
	Package- oder Modulspezifikation
	Qualitätssicherungsplan und Testdokumentation
	Wartungshandbuch
	API Javadoc
	API Dokument
	Benutzerhandbuch
	Administrationshandbuch
	Installationshandbuch
	Betriebshandbuch
	Schulungsunterlagen
Name
Datum, Ort
Unterschrift

JWR@coopXarch.