Dokumentation
Einleitung
"Jetzt kommt mir nicht mit Dokumentation!". "Die Dokumentation schreiben wir dann später.". "Diese Funktion haben wir noch nicht dokumentiert!".
Alles Aussagen die man in der Softwareentwicklungsbranche häufig hört - aber was steckt eigentlich dahinter und was sollte man bezüglich Dokumentation machen. Im nächsten Abschnitt habe ich die verschiedenen Dokumentationsarten zusammengefasst
Alles Aussagen die man in der Softwareentwicklungsbranche häufig hört - aber was steckt eigentlich dahinter und was sollte man bezüglich Dokumentation machen. Im nächsten Abschnitt habe ich die verschiedenen Dokumentationsarten zusammengefasst
Arten von Dokumentation
Entwicklungsdokumentation: Hierzu gehören sämtliche Dokumente, welche während der Entwicklung einer Software (von der Architektur bis zur Abnahme) erstellt werden (sollten) und auch für die Wartung benötigt werden.
Technische Dokumentationen (des Endproduktes): Hierunter zähle ich z.B. Installationsanweisungen, Betriebsdokumentation, etc.
Benutzer Dokumenationen: z.B. Schulungshandbücher, Benutzerhandbücher, etc.
Die vorgängig als "technische Dokumentation" wie auch "Benutzerdokumentation" beschriebenen Handbücher, o.ä. werden häufig erstellt (wenn auch in unterschiedlicher Qualtiät); sie bilden aber meist den Abschluss eines Softwareentwicklungsvorhabens und die Programmierer haben sowieso nicht mehr viel zu codieren; und selbst wenn: hier kann man programmier-externe Personen beiziehen, welche diese Dokumentation aufgrund des Inputs der Autoren erstellen.
Technische Dokumentationen (des Endproduktes): Hierunter zähle ich z.B. Installationsanweisungen, Betriebsdokumentation, etc.
Benutzer Dokumenationen: z.B. Schulungshandbücher, Benutzerhandbücher, etc.
Die vorgängig als "technische Dokumentation" wie auch "Benutzerdokumentation" beschriebenen Handbücher, o.ä. werden häufig erstellt (wenn auch in unterschiedlicher Qualtiät); sie bilden aber meist den Abschluss eines Softwareentwicklungsvorhabens und die Programmierer haben sowieso nicht mehr viel zu codieren; und selbst wenn: hier kann man programmier-externe Personen beiziehen, welche diese Dokumentation aufgrund des Inputs der Autoren erstellen.
Entwicklerdokumentation
Die vorgängig als "technische Dokumentation" wie auch "Benutzerdokumentation" beschriebenen Handbücher, o.ä. werden häufig erstellt (wenn auch in unterschiedlicher Qualtiät); sie bilden aber meist den Abschluss eines Softwareentwicklungsvorhabens und die Programmierer haben sowieso nicht mehr viel zu codieren; und selbst wenn: hier kann man programmier-externe Personen beiziehen, welche diese Dokumentation aufgrund des Inputs der Autoren erstellen.
Komplexe Systeme
Wir Menschen sind nicht fähig komplexe Systeme auf einen Blick zu begreifen. Auf Softwaresysteme trifft dies ebenfalls zu. Die (richtige) Dokumentation kann uns aber helfen ein solches System zu verstehen bzw. den Zugang dazu zu finden. Uns - damit sind die Entwickler welche jetzt daran arbeiten, aber auch andern die vielleicht später einmal unsere Teile in die Hand nehmen müssen (z.B aus Wartungsgründen). Die richtige Dokumentation kann uns auch helfen Fehler frühzeitig zu finden und u.U. sogar Fehlentwicklungen zu vermeiden.
Wann entsteht die Entwickler-Dokumentation
Die Entwicklungsdokumentation entsteht (im Gegensatz z.B. zu einer Installationsanweisung o.ä.) nie im Nachhinein. Architektur wie auch Design müssen erarbeitet werden bevor der Code geschrieben wird; anderenfalls wird sicherlich kein einheitliches Design erzielt bzw. die Architektur nicht eingehalten werden können.