Der Stellenwert einer qualitativen und durchgängigen Dokumentation wird meist unterschätzt. Leistungsumfang und Aufwand der Projektdokumentation werden oft planungstechnisch vernachlässigt. Fehlende Dokumentation hat sowohl negative Auswirkungen auf die Entwicklung als auch auf die Softwarewartung.
Für Xion ist Dokumentation zentraler Bestandteil des Leistungsumfangs und findet sich somit im Projekt- und Qualitätssicherungsplan wieder.
Pflichtenheft und Analysedokumente
Sie sind die Ausgangsbasis für das Problemverständnis und sorgen für die Definition und Abgrenzung der Aufgabenstellung. Die daraus resultierende Konstruktion der Lösung manifestiert sich in der Systemarchitektur und dem Design.
Systemdokumentation
Um die Investition eines Projektes auch langfristig zu sichern, müssen die Voraussetzungen für adaptive Wartung geschaffen werden. Unverzichtbar ist daher eine qualitative System- und Inlinedokumentation.
Analoges gilt für den Produktionsbetrieb: Das Betriebsführungshandbuch ist das Schlüsselelement, um die Lösung operativ zu halten.
Benutzerdokumentation
Die Akzeptanz der Endbenutzer entscheidet meist – wenngleich nicht ausschließlich - über Erfolg und Misserfolg einer Lösung. Da Endbenutzer meist nur rudimentär in den Entwicklungsprozess eingebunden sind, entsteht grundsätzlich eine Distanz zur Lösung. Dieser Kluft muss mit einem Schulungskonzept und entsprechender Benutzerdokumentation (Benutzerhandbuch, Online-Dokumentation) begegnet werden, denn nur wer die Möglichkeiten und die ergonomische Nutzung einer Software kennt, wird sie auch als effektives Arbeitshilfsmittel einstufen.
Sonstige Dokumente
Neben den allgemein gültigen Eigenschaften einer Softwaredokumentation kommen spezifischere Dokumentationsformen abhängig von der Projektart zur Anwendung. Projektartefakte, Reviewergebnisse, Protokolle und dergleichen werden in die projektbegleitende Dokumentation eingepflegt.
Eine qualitative Dokumentation ermöglicht den effektiven Einsatz von Applikationen und verlängert den Lebenszyklus einer Lösung mit positiven Auswirkungen auf die Gesamt-Kosten/Nutzenrechnung.