arc42 in Aktion

Gernot Starke und Peter Hruschka beschreiben in ihrem neuen Buch, wie sich das eigene, vor allem im deutschsprachigen Raum verwendete Dokumentations-Template arc42 sinnvoll nutzen lässt.

Literatur  –  0 Kommentare
arc in Aktion

Gernot Starke, Peter Hruschka
arc in Aktion: Praktische Tipps zur Architekturdokumentation

Hanser, 2016
VII + 190 Seiten, 20 Euro
ISBN 978-3-446-44801-8

Softwarearchitektur gehört vernünftig dokumentiert. Vernünftig bedeutet insbesondere in dem Maß, wie es für das Verständnis des jeweiligen Projekts/Produkts notwendig ist. Und nicht mehr. Das ist zum einen ganz klar weniger als in dokumentenzentrierten Vorgehen wie Wasserfall, besagt andererseits aber auch, dass Dokumentation ein wichtiger Bestandteil agiler Softwareentwicklung ist. Mit arc42 haben die Autoren, Gernot Starke und Peter Hruschka, ein Open-Source-Dokumentations-Template geschaffen, das besonders im deutschsprachigen Raum genutzt wird. Über die Nutzung im englischsprachigen Raum können sie noch nicht sehr viel berichten, doch sind sie dabei, in diesem Bereich mit weiteren Büchern vorzudringen.

Was arc42 ist und wo der Anwender es bekommt, erfährt der Leser zunächst einmal nicht direkt. Vielmehr geht es gleich mit einer beispielhaften Nutzung in der Praxis. An diesem Beispiel erfährt der Leser indirekt, was arc42 ist und kann sich selbst ein Bild machen, ohne erst eine theoretische Abhandlung lesen zu müssen. Dabei ist dieser Teil so aufgebaut, dass in einem Kasten die wichtigsten Aspekte des jeweiligen arc42-Abschnitts genannt werden und darauf die Beispieldokumentation folgt.

arc42, so die Autoren, sei nicht ein Template, das vollständig zu füllen sei. Vielmehr solle sich der Leser es als Schrank mit zwölf Schubladen vorstellen, die sich je nach Bedarf belegen lassen – aber nicht müssen. Die Schubladen haben Namen wie Einführung und Ziele, Lösungsstrategie, Bausteinsicht, Entwurfsentscheidungen und dokumentieren unterschiedliche Aspekte bis hin zum Glossar. Letzteres dient dazu, Neueinsteigern im Projekt die domänenspezifischen Begriffe nahezubringen.

Nach diesem Überblick widmen sich Starke und Hruschka zunächst den Grundregeln effektiver Dokumentation, um dann im größten Abschnitt die einzelnen Schubladen detaillierter zu besprechen. Tipps für den Alltag, Werkzeuge für die Dokumentation wie Editoren oder Wikis und eine FAQ-Liste runden das Buch ab. Mit knapp 200 Seiten bietet das Buch wesentliche Informationen zum Einsatz von arc42, ohne auszuufern. Also genau das, was die Autoren von guter Architekturdokumentation fordern: so wenig wie möglich, aber so viel (und nicht weniger!) wie nötig.

Das Buch lässt sich locker von vorn bis hinten lesen, genauso ist es aber möglich, quer einzusteigen und einzelne Themen herauszupicken. Möglich wird das insbesondere durch einen ungewöhnlichen Schreibstil: Die Überschriften der einzelnen Abschnitte suggerieren nicht durchgehenden Text, sondern lassen das Buch im Lichte einer ausführlichen Liste von Praxis-Tipps erscheinen, da sie mit "Tipp xy" überschrieben sind. Das erlaubt den Autoren, sowohl Tipps wie auch durchgehenden Text aneinanderzureihen als auch hier und da Sprünge vorzunehmen. Teilweise folgt einem Tipp ein weiterer, der anscheinend das Gegenteil des vorherigen vorschlägt. Doch machen die Autoren darauf aufmerksam, dass dies kein Gegensatz, sondern vom jeweiligen Kontext abhängig sei. Große Projekte müssen in einigen Aspekten andersartig dokumentieren als kleine. Doch arc42 liefere immer die passenden Schubladen.

Die Autoren haben schon an anderer Stelle beschrieben, was arc42 ist. Im aktuellen Buch ist das in den Hintergrund gerückt. Hier geht es um die Nutzung. Dennoch kann der Leser ohne Vorwissen um dieses Template starten, da er indirekt – und dennoch sehr schnell – über Beispiele und Tipps in die Nutzung eingeführt wird. Damit ist ein sanfter und pragmatischer Einstieg in eine strukturierte Dokumentation selbst für Doku-Muffel möglich. Und das macht das Buch recht wertvoll. (ane)

Michael Müller
ist als Bereichsleiter Softwareentwicklung der InEK GmbH verantwortlich für Projekte im Web-, Java- und .NET-Umfeld. Daneben betätigt er sich als freier Autor und verfasst Fachartikel zu diversen Entwicklungsthemen sowie Buchrezensionen.