rüping.info
 

 

Agile Documentation

A Pattern Guide to Producing Lightweight Documents for Software Projects


 

John Wiley & Sons (2003)


1. Finding the right topics

2. Structuring individual documents

3. Layout and Typography

4. Infrastructure and technical organisation

5. Management and quality assurance

Inhalt

Dokumentation ist in der Projektpraxis oft durch eine von zwei Extremsituationen gekennzeichnet. In machen Projekten wird fast überhaupt nicht dokumentiert und die existierende Dokumentation ist hoffnungslos veraltet, wodurch wichtiges Wissen verloren geht. Andere Projekten bemühen sich, alles zu dokumentieren, und produzieren mit großem Aufwand sehr viele Dokumente, in denen sich aber letztlich niemand zurecht findet und die daher großenteils nie gelesen werden.

Das (englischsprachige) Buch beschreibt, wie die Dokumentation in IT-Projekten angemessen gestaltet werden kann. Es orientiert sich dabei an den Prinzipien agiler Methoden, die eine kritische Haltung zu umfassender Dokumentation einnehmen. Das Buch empfiehlt, nur Dokumente zu erstellen, die einen tatsächlichen, klar erkennbaren Nutzen haben, zum Beispiel für spätere Projektphasen oder für Folgeprojekte. Außerdem ist es wichtig, Dokumentation als eine von mehreren Formen des Wissensaustauschs im Team zu begreifen: Dokumentation ergänzt die Diskussion im Team, ersetzt sie aber natürlich nicht.

Das Buch enthält 50 Patterns, die zunächst der Frage nachgehen, welche Dokumente in einem Entwicklungsprojekt lohnend sind, und sich dann mit der Gestaltung der Dokumentation befassen. Das Ziel sind prägnante und gut strukturierte Dokumente, die eine hohe Lesbarkeit und einen schnellen und zielsicheren Zugriff auf das darin enthaltene Wissen bieten. Schließlich geht das Buch auf Fragen des Dokumentationsprozesses und -managements ein.



Impressum: Dr. Andreas Rüping, Sodenkamp 21 A, 22337 Hamburg, Steuernummer 26/225/34412 (Finanzamt Hamburg-Nord), USt-Id DE235918641