Entwicklungsdokumentation in Software-Projekten

Häufig trifft man in der Praxis nicht dokumentierte Programme und nie nachgeführte Entwicklungsdokumente an. Die Dokumentation ist aber ein wichtiges Kommunikationsmittel in der Softwareentwicklung. Fehlt diese, kann eine Software kaum weitergeführt werden. Es entstehen (vermeidbare) Kosten für neue Software.

In diesem Seminar lernen Sie Zweck, Aufbau und inhaltliche sowie sprachliche Gestaltung der Dokumentation in der Softwareentwicklung kennen. Der Unterschied zwischen Projekt-, Produkt- und Prozess-Dokumenten wird vermittelt. Sie erfahren, welchen Nutzen Systemdokumentation für Software-Architekten, Entwickler, Tester und Projektverantwortliche hat. Das Seminar behandelt auch den rechtlichen und normativen Rahmen von Software-Dokumentation. Sie erfahren, in welchem Maße heute bei klassischer oder agiler Vorgehensweise dokumentiert werden muss. Anschauliche Beispiele und Übungen runden das Seminar ab.

Dieses Seminar richtet sich an Mitarbeiter in der Softwareentwicklung. Projektverantwortliche, Architekten, Entwickler und Tester lernen, was man wie dokumentiert. Den Verantwortlichen wird das Kosten-Nutzen-Verhältnis einer sorgfältig erstellten Dokumentation vermittelt.

Montag, 18. November 2024
9.00 bis 16.30 Uhr, inkl. Pausen

1. Einleitung 

• Sinn und Zweck von Entwicklungsdokumentation 
• Dokumentation im Software-Lebenszyklus 
• rechtliche und normative Vorgaben 

2. Produkt-Dokumentation je Phase im Lebenszyklus
(je unterschieden nach klassischer oder agiler Entwicklung) 

• Planung: Projekt-Dokumentation, Prozess-Dokumentation 
• Anforderungsanalyse: z.B. Use Case Diagramm, Lastenheft und Pflichtenheft, User Storys mit Akzeptanzkriterien
• Design und Konzeption: z.B. Architekturbeschreibungen, Klassen- und Sequenzdiagramme
• Implementierung: Code-Dokumentation (Inline, Developer Guidelines), API-Dokumentation, Interaktive Dokumentation 
• Testen: Testdokumentation 
• Wartung und Weiterentwicklung: Problembeschreibungen, Änderungsdokumentation 
• Von der Entwickler- zur Benutzerdokumentation

3. Gestaltung von Dokumenten 

• Aufbau und Orientierungshilfen 
• Terminologie und Texte, Regeln für Verständlichkeit 
• Informationseinheiten als Topics (Task, Concept, Reference)

4. Erstellung und Verwaltung von Dokumentation 

• Metadaten zur Kennzeichnung 
• Überblick über redaktionelle Tools, Doc as Code, Wikis 
• Templates, Dokumentenmanagement