Ich werde hier meine Erfahrungen in der Projekt- und Produktdokumentation im Agilen zusammen tragen. Dies erfolgt Schritt für Schritt und ich freue mich schon auf Eure Kommentare.
Agile Dokumentation
Dokumentationsarten
| Produkt | Projekt |
|---|---|
Nutzungshandbuch | Architektur |
| Installationshandbuch | Design |
| Betriebshandbuch | Datenmodell |
| Servicehandbuch | Use-Cases |
| Online-Hilfe | Testfälle |
| Glossar | |
| Leistungsbeschreibung | |
| Arbeitsweisen | |
| Richtlinien | |
| Anforderer: Kunde | Anforderer: Team |
Was braucht das Team?
- Klare Absprachen
- Aktueller Stand der Anforderungen
- Transparenz – Wo, Weshalb, Wer
- Neuen Mitarbeitern soll der Einstieg erleichtert werden.
- Nachschlagewerk (Glossar, Tipps & Tricks, Kurzanleitungen) – langfristiges Wissen
Voraussetzungen
- Orientierung am Leserkreis
- Dokumentation langfristig relevanten Wissens
- Einfache Tools
- Dokumentationsverantwortlicher
- Dokumentenreview zur Qualitätssicherung
- Einbindung in das Team und in den Sprint (DoD)
Herausforderungen für den Technischen Redakteur
- Informationsbeschaffung
Beispiel: Leistungsbeschreibungen sind auf User Stories aufgeteilt - Näher ans Team; Näher ans Produkt
Interaktion hat Vorrang - mehrerer Teams; räumliche Verteilung
Redakteur ist mit mehr als zwei Teams zeitlich überfordert - Besprechungen - Dokumentation im Sprint
Backlog; DoD - Übergreifende Themen
Backlog; Zeitplan
Tools für die Dokumentation
- MS Office (Word, Excel, PowerPoint)
- Enterprise Architect
- HP Application Lifecycle Management (HP ALM)
- JIRA
- Wiki (Confluence, MediaWiki)
- Authoring Tools (Single-Source-Publishing)
Literatur
Titel | Autor | |
|---|---|---|
Dokumentation in agilen Projekten | Andreas Rüping | 978-3-86490-040-2 |
Single Source Publishing | Sissi Closs | 978-3-935042-98-7 |
Darf‘s ein bisschen weniger sein? | Marc Beckers | OBJEKTspectrum, |