Softwarearchitekturen dokumentieren und kommunizieren

Kolumne "Architekturen dokumentieren"

Logo_Kolumne_JavaMagazin.jpg
Die Kolumne war auf 12 Folgen angelegt und erschien zunächst gedruckt 2008 und 2009 im Java Magazin. Später folgte die Veröffentlichung online zunächst bei JAXenter, und nun auch hier (mit freundlicher Genehmigung). Die Inhalte und vor allem die Rückmeldungen dazu waren die Keimzelle für das Buch.

Mission Statement für die Kolumne im Java Magazin

Dokumentation zählt generell nicht zu den Lieblingsbeschäftigungen eines Entwicklers. Speziell die Architektur einer Softwarelösung ist in vielen Fällen nicht angemessen dokumentiert. Wichtige Fragen, die sich der Leser stellt, werden nicht beantwortet, oder die Dokumentation ist zwar umfangreich, aber (auch deshalb?) mit der Zeit veraltet - sie gibt nicht mehr den aktuellen Stand wieder und ist damit nutzlos geworden. Diese Kolumne soll Anregungen geben, wie Architekturen angemessen dokumentiert werden können. Wie kann eine Dokumentation aufgebaut und gepflegt werden? Welche Arbeitsergebnisse und Werkzeuge haben sich in der Praxis bewährt? Dabei soll auch die Agilität im Blick behalten werden. Wie viel Dokumentation hilft wem weiter?
(Stefan Zörner zum Start im Juli 2008)
Folge 1: Architekturen dokumentieren: Voll unagil?

Es ist Montagmorgen, und ein neuer Mitarbeiter verstärkt das Projekt. Der Neue hat viele Fragen: Was leistet das System überhaupt? mehr...


Folge 2: Kombiniere -- der Systemkontext

Waren Sie schon einmal im Krimitheater? Samstagabend, 20:00 Uhr: Auf der Bühne liegt eine Leiche, ein Mord ist geschehen. mehr...


Folge 3: Hat Mozart modelliert?

In der Musik werden Melodien als Noten in einem speziellen Liniensystem visualisiert. Es erlaubt die Angabe von Tonhöhen, -längen und vielem mehr mehr...


Folge 4: Was ist was? Band 127: Unser Softwaresystem

Erinnern Sie sich noch an die "Was ist was?"-Bücher über Natur, Technik und vieles mehr (Was ist was? Band 50: Unser Körper, Tesloff 1972, aktuelle Auflage 2005)? mehr...


Folge 5: Laufzeitsicht: Der jüngste Spieler fängt an!

Brettspiele zu entwickeln ist mit Softwareentwicklung durchaus vergleichbar. Auch hier wird konzipiert, entworfen und getestet. Und dokumentiert! mehr...


Folge 6: Von Software-Messies und Jar-File-Schüttgut

Manche Menschen können sich von nichts trennen. Sie müssen alles aufheben, es könnte ja noch gebraucht werden. Am Ende haben sie keinen Überblick mehr mehr...


Folge 7: Historisch gewachsen? - Entscheidungen festhalten

Wir schreiben das Jahr 1815 – Europa in Aufregung. Napoleon erlebt bei Waterloo ebendieses – er verliert seine letzte Schlacht. mehr...


Folge 8: Für die Ewigkeit? Die Tonne? Oder etwas dazwischen?

Mein Vater hat unlängst die ursprünglich auf Zelluloid gebannten Kindheitserinnerungen seiner Sprösslinge ("Stefan lernt laufen") auf DVD gesichert. mehr...


Folge 9: Big Brother -- Dokumentieren im Container

Wenn ich in Seminaren unterschiedliche Definitionen für den Begriff "Softwarearchitektur" vorstelle, sorgt eine stets für Heiterkeit mehr...


Folge 10: Out of the Box -- Produktkartons

Die Älteren unter uns werden sich noch erinnern: Früher kaufte man Software im Laden in einem Karton. In dem befanden sich dann Disketten, später CDs mehr...


Folge 11: Tartan-Architektur -- Muster dokumentieren

Was macht ein Schotte mit einer Kerze vor dem Spiegel? Er feiert den 2. Advent! Zu den Dingen, die jeder sofort mit Schottland in Verbindung bringt, mehr...


Folge 12: The Big Picture -- Mit Entscheidern kommunizieren

Ran ans Whiteboard, und erklärt! Als Softwarearchitekt kommunizieren Sie Ihre Konzepte und Endscheidungen im Entwicklungsteam. mehr...