Skip to content

Buch: arc42 in Aktion

Titel arc42 in Aktion
Autor Gernot Starke, Peter Hruschka
Sprache Deutsch
Genre Sachbuch
Verlag Hanser Verlag, 2016
Seitenanzahl 190

In vielen Software-Projekten, die länger als ein Jahr leben, gibt es eine Software-Architektur. Nicht immer sieht man sie sofort im Code, nicht immer entspricht die Realität dem Angedachten und sehr oft ist rein gar nichts dazu dokumentiert. Vor allem der letzte Punkt soll sich durch das Buch „arc42 in Aktion – Praktische Tipps zur Architekturdokumentation“ von Gernot Starke und Peter Hruschka bessern.

arc42-Template

Wer es nicht kennt: arc42 ist eine Vorlage für die Entwicklung, Dokumentation und Kommunikation von Software-Architekturen. Mit Template ist dabei keine Vorlage gemeint, die man strikt befolgt und ausfüllt, sondern es gibt eine Gliederung und Hinweise, welche Inhalte eine Architektur-Dokumentation haben kann und sollte.

Das Buch setzt genau dort an und stellt jedes Kapitel des Templates im Detail vor, welches Ziel damit verfolgt wird und wem es etwas nützt. Das Ganze an einem kleinen Beispiel, damit man die Vorlage auch einmal ausgefüllt sieht. Dabei muss man natürlich vor allem als Dokumentschreiber selbst abwägen, welche Teile man übernimmt und welche nicht. Das können die Autoren des Buches einem nicht abnehmen, aber sie geben wie gesagt Hinweise, was sinnvoll sein könnte.

Ich zähle hier nicht auf, wie das arc42-Template aufgebaut ist und welche Teile es enthält. Das kann man auf der Webseite nachschlagen. Positiv erwähnen will ich die Lizenz, denn das Template steht unter der Creative Commons Attribution Lizenz und darf damit von jeder Person frei benutzt, abgeändert und weiterverteilt werden. Nur die Originalquelle muss man angeben, wenn man sich darauf abstützt, was aber kein großes Problem sein sollte. Der Download steht für verschiedene Formate wie Office, LaTeX, Markdown oder HTML zur Verfügung.

Auch für Nicht-arc42-Nutzer

Besonders gefallen hat mir an dem Buch, dass der Sinn hinter der einzelnen Kapitel des arc42-Templates erklärt wird. Damit versteht man nämlich die Hintergründe, auch wenn man nicht arc42 als Template benutzt. So kann man sich sehr leicht einzelne Elemente, die einem zusagen, für die eigene Vorlage übernehmen.

Aus dem Grund fand ich vor allem Kapitel III „Grundregeln effektiver Dokumentation“ so wertvoll. Hier geht es wirklich um die Fallstricke für gute – und damit ist wertschöpfend gemeint – Dokumentation und wie man mit Problemen umgehen kann.

Aber natürlich kochen auch die Autoren bzw. die Entwickler des arc42-Templates nur mit Wasser. Nicht alles, was ich in dem Buch gelesen habe, halte ich für richtig. Nicht alles, was in der arc42-Vorlage steht, für sinnvoll. Alles in allem hat das Buch aber einen Mehrwert für jeden, der Architektur-Dokumente schreibt.

Nachtrag: Für mich sind die Grenzen zwischen Design und Architektur fließend. Aus dem Grund unterscheide ich nicht zwischen Architektur- und Design-Dokumenten. Deswegen können alle Tipps aus dem Buch fast eins zu eins für Design-Dokumente – oder allgemein fast jede Art von Dokumentation – übernommen werden.