Einstieg Was ist arc42?
Aufbau der Vorlage
Rezeption – Kritik an arc42
Beispiele für den Einsatz von arc42
FAQ – Häufig gestellte Fragen
arc42 ist ein Vorschlag, wie sich die Architekturdokumentation eines Software-Systems gliedern lässt. Insbesondere im Deutschsprachigem Raum ist diese Vorlage sehr verbreitet. Viele Unternehmen und Organisationen setzen sie in ihren Entwicklungsvorhaben ein.
Die Urfassung von arc42 haben Gernot Starke und Peter Hruschka bereits 2005 in Form eines Word-Templates bereitgestellt. Erste Erwähnung in der Literatur ist ein Artikel von den beiden im Objekt Spektrum. Der Titel: „Praktische Architekturdokumentation: Wie wenig ist genau richtig?“
Heute ist arc42 ein Open Source Projekt auf GitHub. Es ist in vielen Sprachen und Formaten verfügbar. Der Master ist nicht mehr Word sondern asciidoc.
Die arc42-Gliederung schlägt 12 Abschnitte vor, die teilweise noch untergliedert sind. Mit etwas Abstand betrachtet zerfallen die Inhalte in 3 Gruppen.
Mit seinen 12 Abschnitten wird arc42 mitunter als zu schwergewichtig empfunden. Auch heißt oft, dass arc42 vor allem in DACH relevant ist, und außerhalb keine großen Rolle spielt.
Eine interessante Alternative zu arc42 stellen die Arbeiten von Simon Brown dar, speziell sein Software Guidebook. Sein berühmtes C4 Modell ist eher eine Alternative zu UML. Es lässt sich in Form der Sichten mit arc42 kombinieren.
In einem viel beachteten Blogbeitrag diskutiert Stefan Zörner verschiedene Ansätze wie das Software Guidebook, C4 und Diataxis und vergleicht sie mit arc42.
Blogbeitrag: Ist dieses arc42 eigentlich alternativlos?
Auch wenn arc42 flächendeckend in vielen Unternehmen und Organisationen zum Einsatz kommt, und das auch schon seit vielen Jahren, sind frei zugängliche Beispiele rah. Unternehmen machen ihre Dokumentationen schlicht nicht öffentlich.
Gleichwohl gibt es mittlerweile einiges an Anschauungsmaterial, was auch wichtig ist. Entwicklungsteams nutzen Beispiele gerne zur Inspiration.
DokChess
Einen besonderen Stellenwert hat seit langem dieses Fallbeispiel für ein Programm, das Schach spielen kann. Es entstand für das Buch von Stefan Zörner zu Architekturdokumentation im Hanser-Verlag und ist online frei verfügbar.
dokchess.de
Komplettes Beispiel für eine Architekturdokumentation mit arc42 auf Deutsch und Englisch.
Gradle
Mit jedem Beitrag dieser Blog-Serie stellt Stefan Zörner anhand des Build-Werkzeugs Gradle eine Zutat für eine Architekturbeschreibung vor, und ordnet sie in die Gliederungsstruktur von arc42 ein. In Summe fügen sie sich passgenau zu einem Gesamtbild zusammen, einem Architekturüberblick für Gradle.
arc42-Starschnitt Gradle
Ein Architekturüberblick in Lebensgröße. Alle Beiträge diese Blog-Serie online lesen …
Unsere Themenseite zu Architekturdokumentation enthält weitere Beispiele für Architekturüberblicke, die schlanker sind als arc42, aber wichtige Elemente daraus wie Qualitätsziele und Lösungsstrategien enthalten.