Softwarearchitekturen dokumentieren und kommunizieren

Stefan Zörner
Softwarearchitekturen dokumentieren und kommunizieren
Entwürfe, Entscheidungen und Lösungen nachvollziehbar und wirkungsvoll festhalten

Carl Hanser 2012
265 Seiten
€ 34,90
ISBN 978-3-446-42924-6

Es gibt diverse Bücher über Softwarearchitekturen. Stefan Zörner widmet allein der Dokumentation und der damit verbundenen Kommunikation ein ganzes. Das ermöglicht ihm, das Thema deutlich detaillierter als üblich auszuleuchten. Softwarearchitekten sind häufig erfahrene Entwickler, aber denen sagt man im Allgemeinen nach, nicht gerade dokumentierfreudig zu sein. Die Bedeutung von Dokumentation bemerkt man aber spätestens, wenn ein neuer Mitarbeiter in ein Projekt einsteigen soll. Wohl dem, der zumindest einen Architekturüberblick festgehalten hat. Der Verweis auf ein verwaistes Projektwiki oder Textdokument hilft allerdings nicht unbedingt weiter.

Was auf ein weiteres Problem hindeutet: Dokumention will gepflegt sein. Was für Informationen braucht die neue Teamkollegin, um am Projekt mit entwickeln zu können? Solche über die Projektvision, Kernelemente, zentrale Abläufe, genutzte Programmiersprachen und Frameworks, nicht zuletzt, warum bestimmte Bibliotheken nicht genutzt wurden. Kurz, alles was mit der Architektur des Systems zusammenhängt. Und das in einem Umfang, der nicht abschreckt.

Bevor der Autor auf solche Fragen eingeht, klärt er, was Dokumentation und Architektur bedeuten – und stimmt den Leser auf ein wenig Schachspiel ein. Denn im Laufe des Buchs, ergänzt um downloadbaren Sourcecode, entsteht eine Schachplattform. Das heißt jedoch nicht, dass es ums Programmieren geht. Vielmehr nutzt Zörner es lediglich, um zu zeigen, wie verschiedene Architekturaspekte sinnvoll zu dokumentieren sind. Da geht es beispielsweise um die Dokumentation verschiedener Sichten auf die Architektur oder das Festhalten übergreifender Konzepte. Und weil bekanntlich ein Bild mehr sagt als tausend Worte, gehören zur Dokumentationen neben Text und Tabellen Diagramme, vorzugsweise in UML.

Außerdem geht der Band auf das Womit und entsprechende Tools ein. Nachdem der Leser nach und nach alles Wissenswerte erfahren hat, bekommt er die komplette Architekturdokumentation zur besprochenen Schach-Engine. In diesem Kapitel stellt er das vorher vermittelte Wissen anhand eines Fallbeispiels dar, mit ungefähr dem Umfang, wie ihn der Autor für eine Projektdokumentation empfiehlt.

Insgesamt ein lesenswertes Buch, reichlich bebildert und mit eingestreuten Praxistipps versehen. Es schadet Entwicklern nichts, sich mit diesem Thema auseinanderzusetzen, insbesondere, wenn sie Entwurfsideen festhalten möchten. Und genau diese beiden Personenkreise benennt der Verlag als Zielgruppe. (ane)