Dokumentation in agilen Projekten
Kommentare

Die Autoren des agilen Manifests schätzen laufende Software mehr als eine umfassende Dokumentation. Daraus abzuleiten, Dokumentationen seien unwichtig, ist aber ein vielzitierter Fehlschluss, betonen

Die Autoren des agilen Manifests schätzen laufende Software mehr als eine umfassende Dokumentation. Daraus abzuleiten, Dokumentationen seien unwichtig, ist aber ein vielzitierter Fehlschluss, betonen die Autoren. Schließlich ist in ihren Prinzipien die Rede davon, dass die linke Seite, auf der sich die laufende Software befindet, zwar wichtiger sei als die rechte, wo die Dokumentationen zu finden sind, die rechte aber eben auch wichtig sei.

Dokumentation in agilen Projekten

Andreas Rüping geht genau darauf ein, wenn er im ersten Kapitel einen kurzen Abriss über verschiedene Entwicklungsmethoden gibt und auf die jeweils erforderliche Dokumentation eingeht. Dokumentation im Rahmen der agilen Entwicklung erfordert nicht nur eine andere Art der Dokumentation, sondern auch eine andere Menge. Zeichnen sich ältere Vorgehen wie das Wasserfallmodell durch eine starke Dokumentationslastigkeit aus, fehlt diese bei spontanen Entwicklungen oftmals. Ziel der agilen Dokumentation ist es jedoch, alle erforderlichen Dokumente so zu erstellen, dass sie auch nutzbringend für den Leser sind. Das lässt sich einfach umschreiben als: So wenig wie möglich, aber so viel wie nötig.

Der Untertitel „Lösungsmuster für bedarfsgerechtes Vorgehen“ ist in Rüpings Buch Programm: In Anlehnung an Design-Patterns betrachtet der Autor diverse Aspekte der Dokumentation unter einem standardisierten Blickwinkel: Kontext, Problem, Analyse, Lösung, Details und Diskussion sind die Stichworte, nach denen er bestimmte Vorgehen, die Werkzeugwahl, den Umfang und andere Aspekte der Dokumentation strukturiert.

Bereits der Einstieg in das Thema der agilen Vorgehensweise orientiert sich an dieser Strukturierung. Es handelt von der Orientierung am Leserkreis, Skalierung der Dokumentation und dem Erkenntnisgewinn. Sodann geht es über die Werkzeugwahl und über Wikis bis hin zu bedarfsgerechten Formaten. Nicht alles muss druckreif gelayoutet werden, an vielen Stellen reichen auch ein Eintrag im Wiki oder strukturierte Kommentare im Sourcecode. Optimal ist es dann, wenn aus den Daten Dokumente in unterschiedlichen Formaten generiert werden können. Ähnlich der agilen Softwareentwicklung setzt Rüping auch bei der Doku auf eine Planung der Anforderungen und Zielgruppe, die Einbindung des Kunden, ein inkrementelles Vorgehen sowie auf Reviews, um den Inhalt gut zu gestalten.

Abseits von Empfehlungen zu Inhalt und Gestaltung geht es auch um den Umgang mit der Dokumentation. Schließlich werden im agilen Umfeld nicht massenhaft Anforderungen spezifiziert, dokumentiert und vergessen, sondern der Hauptfokus liegt immer wieder darauf, zielgerichtet genau das Notwendige zu erstellen.

Im Anhang bietet der Autor eine überblicksartige Kurzfassung seiner Muster sowie ein Portfolio möglicher Dokumente. Ein Glossar, ein umfangreiches Literaturverzeichnis und der übliche Index schließen das Buch ab.

Ist in einem Projekt nicht gerade ein technischer Redakteur involviert, wird die Dokumentation oft als lästiges Übel empfunden und dementsprechend zu knapp gehalten. Der Autor schärft den Blick für das Notwendige. Die Formulierung als Muster hilft, genau die Bausteine herauszusuchen, die für das eigene Projekt benötigt werden. So kann das Projektwissen effizient für die nächste Entwicklergeneration bewahrt werden.

Unsere Redaktion empfiehlt:

Relevante Beiträge

Meinungen zu diesem Beitrag

X
- Gib Deinen Standort ein -
- or -