embarc logo
embarc logo

Softwarchitekturen dokumentieren und kommunzieren.

Stefan Zörner Stefan Zörner
10.12.2021

Lesezeit: 3 Minuten

Die dritte Auflage ist druckfrisch bei Hanser erschienen. Worum geht es überhaupt, und was ist neu?

Paket mit Büchern

Mein Buch über Architekturdokumentation erblickte 2012 das Licht der Welt. 2015 erhielt es eine 2. Auflage, nun im Dezember 2021 eine dritte.

Worum geht es

Mein Buch zeigt, wie Ihr die zentralen Lösungsansätze Eurer Softwaresysteme so festhalten könnt, dass sie Euch bei der Entwicklung und Weiterentwicklung helfen. Und dass sie Eure Architektur erklärbar, nachvollziehbar und bewertbar machen. Zum Beispiele gegenüber neuen im Team.

Dabei betrachte ich sowohl die Situation, dass Ihr ein neues Softwaresystem baut, als auch das “Nachdokumentieren” bestehender Lösungen.

Stefan Zörner mit Buch

 
 

Was ist besonders?

Von Beginn in war die Grundidee mit kleinen “Zutaten” zu arbeiten, die Ihr mit überschaubarem Aufwand initial anfertigen und für unterschiedliche Zielgruppen rekombinieren könnt. Von diesen Zutaten (oder Dokumentationsmitteln) zeigt das Buch 15 Stück. Jeweils mit Beispielen, Hinweisen zum Anfertigen und einem Steckbrief inklusive Checkliste.

Eine ganz besondere Rolle im Buch spielt das Schach-Programm DokChess. Ich hatte es speziell für das Buch konzipiert und in Java implementiert. Für alle Zutaten ist ein DokChess-Beispiel dabei; die Schnipsel fügen sich dann zu einer umfangreichen Architekturbeschreibung, die nach arc42 strukturiert ist.

Apropos arc42: Den beliebten Gliederungsvorschlag für Architekturbeschreibungen diskutiere ich im Buch ebenso wie Alternativen dazu. Weiterhin Tipps zu Tools, zum Vorgehen …

Was ist neu in der dritten Auflage?

Drei Auflagen

Hier drei Highlights aus meiner Sicht:

Als erstes als Trendthema der letzten Jahre Docs-as-Code. Kurz für „Treat Documentation as Code“ verfolgt es die Philosophie, Dokumentation in einem Entwicklungsvorhaben genau so zu behandeln wie den Quelltext. Die Konzepte dahinter kamen auch in früheren Auflagen bereits vor – die dritte behandelt Docs-as-Code mit einem eigenen Unterkapitel nun explizit.

Weiterhin neu ist ein Unterkapitel zu prägnanten Architekturüberblicken. Ich diskutiere das aus meiner Sicht minimale Set an Zutaten.

Eine besondere Herausforderung für Dokumentation sind größere Softwaresysteme, an denen mehrere Teams gemeinsam arbeiten. Microservices ist ein in den letzten Jahren viel diskutierter Architekturstil. Lösungen nach diesem Bauprinzip fallen gerne in diese Kategorie, ebenso Self-contained-Systems oder SOA-Landschaften (gibt es noch). Im Buch stelle ich einen Ansatz vor, wie Ihr die Dokumentation solcher Softwarelösungen organisiert bekommt.

 
 

Neugierig?

Wenn Ihr Euch ein besseres Bild von der dritten Auflage machen wollt: Die Webseite zum Buch hält unter anderem das komplette 3. Kapitel als Leseprobe bereits.

Softwarearchitekturen dokumentieren cover

Softwarearchitekturen dokumentieren und kommunizieren
Entwürfe, Entscheidungen und Lösungen nachvollziehbar und wirkungsvoll festhalten
Hanser Fachbuch
3., überarbeitete und erweiterte Auflage (Dez. 2021)
309 Seiten. Fester Einband
ISBN: 978-3-446-46928-0

Webseite zum Buch: www.swadok.de
Das Buch beim Hanser-Verlag kaufen
Das Buch bei Amazon kaufen

Webseite zum Buch