Dokumentation in agilen Prozessen

Transkript

1 Datum: 17. Mai 2010 Themendossier Seite 1

2 Einführung in das Thema Seitdem Softwareprodukte zu immer komplexeren Systemen heranwachsen, rückt die Aufgabe der Dokumentation solcher Systeme immer mehr in den Vordergrund. Es existieren inzwischen umfangreiche Standards, die beschreiben, wie eine solche Dokumentation aussehen sollte. Ziel dieser Bemühungen ist es, qualitativ hochwertige Dokumentationsartefakte aus den unterschiedlichen Phasen des Entwicklungsprozesses zu erhalten. Eine gut strukturierte und fehlerfreie Dokumentation hilft dabei, komplexe Anwendungen besser zu verstehen, zu steuern und zu überprüfen. Eine schlechte oder gar nicht vorhandene Dokumentation hingegen erhöht Entwicklungs- und Betriebsrisiken erheblich. Der erste Teil unseres Themendossiers Dokumentation in Softwareprojekten stellt die Grundlagen der Dokumentation in Softwareprojekten vor. Doch die Erstellung einer umfangreichen Dokumentation nach der Vorgabe klassischer Vorgehensmodelle hat auch Nachteile. Sie wird schnell unübersichtlich und komplex, eine Konsistenzerhaltung erfordert großen Aufwand und ist zeitraubend. Dagegen setzen agile Prozessmodelle wie z. B. Scrum auf eine stark reduzierte Dokumentation. Aber auch unabhängig von solchen Prozessmodellen wurde die Idee der Agilität inzwischen auch auf den Bereich der Dokumentation übertragen. Ein wesentliches Prinzip dieser agilen Dokumentation ist es, immer wieder zu hinterfragen, ob die Erstellung eines bestimmten Dokumentes tatsächlich eine Berechtigung hat. Oftmals entstehen in der Softwareentwicklung Dokumente, die keinen Nutzen bringen die Zeit für deren Erstellung hätte man sich sparen können. Des Weiteren befasst sich die agile Dokumentation aber auch mit einer Optimierung des Aufbaus von Dokumenten. Der Ersteller neigt ggf. bei Benutzung von Templates aus anderen Prozessmodellen dazu, alle Dokumentbereiche füllen zu müssen, obwohl manche Stellen für ihn und das Projekt keine Relevanz besitzen. So entsteht überflüssige und ggf. auch unsinnige Dokumentation, die es zu vermeiden gilt. Die Idee der agilen Dokumentation setzt auf dynamische, lebende Dokumente, die keine 100%ige Vollständigkeit anstreben. Die Prinzipien agiler Dokumentation werden im zweiten Teil Agile Dokumentation dieses Themendossiers beschrieben. Im dritten Teil Erfahrungsberichte und Studien geht das Themendossier näher darauf ein, welche Praxiserfahrungen mit agiler Dokumentation gemacht wurden und welche Probleme ggf. auftreten können. Im letzten Teil des Themendossiers betrachten wir schließlich die Dokumentation im Spannungsfeld zwischen traditionellen und agilen Prozessen. Dabei gehen wir unter anderem auf die Frage ein, welche Rolle die Dokumentation von Architekturen spielt. Wir wünschen Ihnen eine interessante Lektüre! Bei Fragen kommen Sie gern auf uns zu. Ihr Team der Softwareforen Leipzig Seite 2

3 Inhaltsverzeichnis Dokumentation in Softwareprojekten Kapitel Prinzipien der Implementierung aus Lehrbuch der Software-Technik (S ) Software-Dokumentation Praktikable Wiederverwendung von Software-Entwicklungsdokumenten und -prozessen Richtlinien zur Softwaredokumentation Agile Dokumentation Agile/Lean Documentation: Strategies for Agile Software Development Best Practices for Agile/Lean Documentation Agile Documentation: A Pattern Guide to Producing Lightweight Documents for Software Projects Software-Entwicklung Dokumentation Erfahrungen und Studien Problems in agile trenches After the Scrum: Twenty Years of Working without Documentation Dokumentation im Spannungsfeld zwischen traditionellen und agilen Prozessen Architekturen dokumentieren: Voll unagil? Agile Methoden: Ein Überblick und Vergleich zu traditionellen Methoden Seite 3

4 Kapitel Prinzipien der Implementierung aus Lehrbuch der Software-Technik (S ) Quelle: Spektrum Akademischer Verlag; 2. Auflage Autor: Helmut Balzert Datum: 2001 In dem Buch von Helmut Balzert werden die Prinzipen der Implementierung vorgestellt. Dabei ist nicht nur das Prinzip der integrierten Dokumentation interessant, sondern auch das Prinzip der Verbalisierung, das Prinzip der problemadäquaten Datentypen sowie das Prinzip der Verfeinerung. Zusammen bilden diese einen gut leserlichen und gut dokumentierten Quellcode und sollten daher von jedem Programmierer verinnerlicht werden. Software-Dokumentation Quelle: Uni Saarbrücken Autor: Prof. Dr. Andreas Zeller Datum: In den Folien zeigt Prof. Dr. Zeller anhand von Beispielen, wie man den Quellcode nicht dokumentieren sollte und wie man es besser machen kann. Neben allgemeinen Grundregeln wird auch auf Literate Programming und JavaDoc eingegangen. Praktikable Wiederverwendung von Software-Entwicklungsdokumenten und -prozessen html?tx_mwjournals_pi1[showuid]=2282 Quelle: Objekt Spektrum 03/2008 Autor: Dr. Tobias Häberlein, Dr. Hannes Omasreiter Datum: 5/2008 Seite 4

5 Der Artikel beschreibt mehrere praxiserprobte Wiederverwendungstechniken zum Aufbau von Dokumenten aus der Automobilindustrie. Es wird dabei darauf eingegangen, wie diese Techniken unterschiedliche Sichten der verschiedenen Rollen im Softwareentwicklungsprozess auf die Dokumente unterstützen. Desweiteren werden die Vor- und Nachteile dieser zum Beispiel im Bezug auf Wartbarkeit oder Lesbarkeit aufgelistet. Richtlinien zur Softwaredokumentation Quelle: RWTH Aachen Autor: Jürgen A. Lamers Datum: In diesem Dokument findet man eine Übersicht über unterschiedliche Dokumentationsformen. Es wird unter anderem auf die Funktionen und Arten der Dokumentation eingegangen. Weiterhin werden Richtlinien vorgestellt, die man beachten sollte. Etwas ausführlicher wird das Thema der Programmdokumentation behandelt, wobei am Ende eine Checkliste zur Verfügung gestellt wird, die bei der Bewertung und Erstellung dieser Programmdokumente helfen soll. Agile/Lean Documentation: Strategies for Agile Software Development Quelle: Autor: Scott W. Ambler Datum: k. A. Die Seite von Scott W. Ambler bietet eine Einführung in das Thema der agilen Dokumentation. Neben Grundlagenwissen, weshalb und was man eigentlich dokumentiert und an wen sich diese Unterlagen richten, wird beschrieben, was to travel light heißt und wie sich dieser Aspekt auf die Anfertigung und Wartung der Dokumentation auswirkt. Außerdem wird noch auf unterschiedlichste Punkte eingegangen wie z. B. ob die Nutzung von Templates sinnvoll ist oder welche Fragen man sich stellen muss, um ein Dokument effektiv und ballastfrei zu gestalten. Seite 5

6 Best Practices for Agile/Lean Documentation Quelle: Autor: Scott W. Ambler Datum: k. A. Wie der Titel schon verrät, sind auf dieser Seite einige Best Practices über knappe Dokumentation zu finden. Es werden ein paar Richtlinien gegeben, die man beim Schreiben von Unterlagen beachten sollte und wie man diese möglichst einfach hält. Außerdem findet man ein paar nützliche Tipps, um zu bestimmen, was und wann man dokumentieren sollte. Am Ende der Seite werden noch ein paar generelle Praktiken vorgestellt (z. B. dass man die Dokumentation wie eine Anforderung handhaben sollte). Agile Documentation: A Pattern Guide to Producing Lightweight Documents for Software Projects Quelle: Wiley & Sons Autor: Andreas Rüpping Datum: 2003 Das Buch bietet einen Leitfaden dafür, wie man leichtgewichtete Dokumentation durchführen kann. Es sticht durch seine Vielzahl an Praxisbeispielen hervor. Es gibt nützliche Hinweise, in welchen Situationen Details in die Dokumente aufgenommen werden sollten und wann es hilfreicher ist, diese von Angesicht zu Angesicht zu klären. Weiterhin stellt das Buch Lösungen für übliche Probleme bereit und unterstützt den Leser dabei, die Auswahl der richtigen Dokumentationstools und -techniken zu treffen. Seite 6

7 Software-Entwicklung Dokumentation Quelle: Autor: Pierre Feldbusch Datum: k. A. Auf der Internetseite findet man eine Auflistung unterschiedlicher Betrachtungspunkte, die aus der Erfahrung des Autors eine wichtige Rolle in der Softwareentwicklung spielen. Da Dokumentationsartefakte mit fortschreitender Projektzeit stetig wachsen und zu einem hohen Wartungsaufwand führen können, sollte man erst einmal klären, welchen Zweck diese erfüllen sollen, wer sie liest und wer sie warten soll. Neben einer Aufzählung von Dokumentationsmedien findet man auch Tipps zu häufig erstellten Artefakten, wie die Dokumentation als Vertrag, das Fachkonzept und die Entwicklerdokumentation. Problems in agile trenches Quelle: ACM Portal Autor: Mira Kajko-Mattsson Datum: 2008 Diese Studie versucht, die Probleme in der Dokumentation innerhalb agiler Unternehmen zusammenzufassen. Es wurden 18 Unternehmen mit Projektgrößen von 1000 bis hin zu Lines of Code interviewet. Die teilnehmenden Firmen nutzten Scrum, XP und diverse Modifikationen davon. Die Fragen, denen sich die Unternehmen stellen mussten, zielen auf produktabhängige Probleme, wie z.b. den Verlust von kritischem Wissen durch Teamveränderungen oder das Vergessen von Systemwissen durch die Entwickler sowie auf prozessabhängige Probleme, wie z.b. das nicht in der Lage sein, seinen Prozess zu überwachen und zu steuern, ab. Die Ergebnisse werden schließlich ausgewertet, wobei Firmen, bei denen ein Problem nicht auftrat, sich dazu äußern, wie sie dieses Problembewältigt haben. Seite 7

8 After the Scrum: Twenty Years of Working without Documentation Quelle: Autor: S. Ratanotayanon, J. Kotak, S. Elliot Sim Datum: 2006 In dem Artikel wird das Vorgehen einer Firma beschrieben, die schon seit 20 Jahren mit wenigen Dokumenten arbeitet und trotzdem damit sehr effizient ist und wenig Know-how verliert. Es wird unter anderem beschrieben welchen Methoden sich dieses Unternehmen bedient und wie das Wissen gepflegt wird. Des Weiteren wird beschrieben, was lebende Dokumente sind und wie man sie einsetzt. Zum Schluss werden die angewandten Methoden von den Autoren untersucht und die Erfolgsfaktoren analysiert. Architekturen dokumentieren: Voll unagil? Quelle: Java Magazin 10/2008 Autor: Stefan Zörner Datum: In dieser Kolumne beschreibt der Autor aus seiner Sicht warum es nötig ist, die Architektur eines Systems zu dokumentieren. Sie besteht aus folgenden fünf Teilen: Von Software-Messies und Jar-File-Schüttgut, Laufzeitsicht Der jüngste Spieler fängt an", Unser Softwaresystem", Hat Mozart modelliert?" und Kombiniere - der Systemkontext". Der erste Teil beschäftigt sich mit der Visualisierung genutzter Bibliotheken und deren Beziehungen zum Projekt. Der Zweite befasst sich mit der Sicht auf dynamische Aspekte des Softwaresystems. Der Dritte beschreibt die Zerlegung eines Systems in seine Komponenten. Der vierte Teil beschäftigt sich mit der Frage der Tiefe und Anzahl von Architekturdokumenten und der Letzte mit der Darstellung des Systems zu anderen verknüpften Systemen. Seite 8

9 Agile Methoden: Ein Überblick und Vergleich zu traditionellen Methoden l.ppt Quelle: TU München Autor: Gerd Beneken Datum: k. A. In der Präsentation von Gerd Beneken findet man einen Vergleich von traditionellen Methoden zu agilen Methoden. Es wird unter anderem auch auf das Thema der Dokumentation eingegangen, wobei sich die traditionellen Vorgehen eher schwergewichtig, die Agilen leichtgewichtig gestalten. Seite 9

10 Impressum Autor Johannes Perlet Telefon: +49 (0) Feedback Uns interessiert Ihre Meinung! Haben Sie Fragen, Anregungen oder Anlass zur Kritik? Bitte senden Sie Ihre Kommentare an: Sven Seiffert Telefon: +49 (0) Abmeldung Sie wollen dieses Dokument in Zukunft nicht mehr empfangen? Senden Sie uns einfach eine mit einer kurzen Nachricht an: Zugangsdaten für Sehr gern richten wir für Sie Zugangsdaten für unseren passwortgeschützten Bereich "Wissen" ein (für unsere Partnerunternehmen; für andere Unternehmen sind Probezugänge möglich). Senden Sie uns einfach eine mit einer kurzen Nachricht an Seite 10

11 Seite 11 Softwareforen Leipzig GmbH Querstraße Leipzig T +49 (0)341 / F +49 (0)341 / E info@softwareforen.de I