Einführungen und Motivation
- Anforderungen an die IT-Dokumentation
- Nutzen einer effizienten Dokumentation im IT-Alltag
Dokumentationsbedarf - Welche Inhalte sind zu dokumentieren?
- Softwareentwicklung (Entwicklungsrichtlinie, Softwarearchitektur, Softwaredesign, Entwicklerdokumentation, SW-Code etc.)
- IT-Betriebe (Systemarchitektur, IT-Betriebshandbuch, Runbooks etc.)
Dokumentation in agilen Projekten
- Die 'Definition of Done' in Scrum-Projekten
- Das 'Cumulative Flow Diagram (CFD)' in Kanban-Projekten
Die Kunst des effizienten Schreibens
- Das Inhaltsverzeichnis - geben Sie sich eine Struktur
- Die Abbildung - Bilder sagen mehr als 1.000 Worte
- Tabellen, Aufzählungen, Verweise - Fassen Sie sich kurz
Kleine Stilbibel für gute Texte
Werkzeuge und Notation für effizientes Dokumentieren
- Markdown - Texte kurz, knapp und ohne Schnörkel erstellen
- PlantUML - UML-Diagramme textuell beschreiben
- SQL - Möglichkeiten der Datenbank-Schemanotation ausnutzen
- Softwarecode - Selbstbeschreibender SW-Code versus/und Inline-Dokumentation
Review und Qualitätssicherung
- Softwarecode-Dokumentation mittels SonarQube validieren
- Redaktionelle Betreuung von Dokumentationsquellen (Wiki)