Der Architecture Communication Canvas

Seit dem BMC im Jahre 2010 sind eine Reihe weiterer Canvas-Modelle hinzugekommen, etwa der Lean UX Canvas, der Product Design Canvas oder der für Fans von Domain-driven Design hilfreiche Bounded Context Canvas (s. Abb. 1) [2].

Was ist überhaupt ein Canvas?

In der Softwareentwicklung, insbesondere in der Entwicklung grafischer Systeme, ist der Begriff "Canvas" durch UI-Frameworks (wie Java2D, JavaFX, WPF, wxPython oder HTML5) als Zeichenfläche bekannt, auf dem grafische Elemente gezeichnet bzw. programmiert werden können. Für unser Thema "kompakte Dokumentation" erklären wir den Canvas deswegen etwas anders:

Ein Canvas ist eine strukturierte Aufbereitung von Schlüsselelementen eines Themas.

Veranschaulichen wir diese Definition noch genauer:

"Strukturierte Aufbereitung" meint die grafische Anordnung bestimmter Informationskategorien. Betrachten Sie Abb. 2, in der wir ein paar Informationskategorien (wie Geographie, Wirtschaft, Kultur etc.) über Städte und Länder "strukturiert angeordnet" haben.

... von Schlüsselelementen eines Themas

"Schlüsselelemente" sind wichtige Informationen zu einem Thema. Das können Geschäftsmodelle sein, wie beim Business Model Canvas, oder eben wichtige Informationen zu einem Softwaresystem. Die Konzentration auf wesentliche Elemente kennen wir auch als "Abstraktion" oder Modellbildung – also dem Weglassen von Details. Solche Modelle dienen einem konkreten Zweck und welche Elemente ein Modell jeweils hervorhebt, hängt genau von diesem Zweck ab. Für das Beispiel der Städte und Länder haben wir die Geschichte, berühmte Persönlichkeiten, volkswirtschaftliche Kennzahlen und vieles anderes weggelassen.

Die Idee solcher Verkürzung haben sich schon frühere Generationen zunutze gemacht und sogenannte "Steckbriefe" verfasst. Ursprünglich dienten diese dazu, eines Verbrechens verdächtige Personen zu finden. Heute nutzen wir Steckbriefe als Zusammenfassung wesentlicher Fakten über Personen, Orte oder Ereignisse. Wie so etwas aussehen könnte, haben wir in Abb. 3 beispielhaft skizziert.

Aber zurück zu Software und IT. Dort können Sie einen Canvas und im Speziellen den Architecture Communication Canvas für die technische Dokumentation Ihrer Systeme verwenden.

Dafür gibt es doch schon arc42?!

Natürlich können Sie das arc42-Template für die Beschreibung Ihrer Systeme verwenden, schließlich ist es ja genau dafür gedacht [3]. Sicherlich können Sie arc42 auch sparsam einsetzen und damit kompakte Dokumentation produzieren. In der Praxis kommt arc42 jedoch meist als ein umfangreiches Dokument oder Wiki daher; das erscheint manchen Teams oder Menschen zu viel oder zu umständlich.

Wir haben in der Praxis häufiger den Ruf nach "noch kürzer" gehört und mit verschiedenen Teams aus unterschiedlichen Branchen an noch kompakteren Versionen von Dokumentation gearbeitet. Lange Zeit haben wir die Ergebnisse allerdings in der (klassischen) Form des Templates abgelegt. Das funktioniert an sich gut, hat aber nicht den Steckbriefcharakter, den ein Canvas mit sich bringt.

Was die anderen Disziplinen können, schaffen wir in der Softwarearchitektur auch: In super-kompakter Form die wesentlichen Highlights eines Systems in strukturierter Form darzustellen – mit dem Architecture Communication Canvas.

In typischer arc42-Manier steht dieser Canvas unter einer liberalen Open-Source-Lizenz, d. h., Sie dürfen ihn auch im kommerziellen/beruflichen Umfeld verwenden. Canvas und Dokumentation sowie die zugehörige Website [4] werden in einem öffentlichen Github-Repository gepflegt [5]. Am Ende des Artikels haben wir für Sie die verschiedenen Formate aufgelistet, in welchen der Canvas verfügbar ist.

Schlüsselelemente von IT-Systemen

Um die wesentlichen inneren Details von IT-Systemen wirklich zu verstehen, benötigen wir Antworten auf drei Kernfragen:

1. Welche Aufgabe löst das System? Was sind die Anforderungen daran?
2. Wie sieht die Lösung aus? Was sind die wesentlichen Aspekte der Architektur?
3. Welche Probleme gibt es?

Wenn wir diese drei Fragen etwas spezifischer formulieren, gelangen wir zu folgender Liste von "Schlüsselelementen", über die wir bei IT-Systemen Bescheid wissen sollten:

• Was ist der Business-Case dieses Systems? Warum gibt es dieses System?
• Was sind die wesentlichen Fähigkeiten oder Funktionen dieses Systems?
• Was sind die wesentlichen Qualitätsanforderungen an das System, etwa Skalierbarkeit, Sicherheit, Zuverlässigkeit oder Benutzungsfreundlichkeit?
• Wer sind die wesentlichen Stakeholder?
• In welchem Umfeld existiert unser System?
• Was sind die wichtigsten oder prägnantesten Entscheidungen, die getroffen wurden – gute wie schlechte?
• Was sind die wesentlichen Bestandteile (aka Komponenten, Bausteine, Module) des Systems?
• Was sind die wesentlichen Technologien?
• Was sind die wesentlichen Risiken und Probleme?

All diese Informationen finden Sie auch im bekannten arc42-Template, aber manchmal benötigen Sie eben eine besonders kompakte Fassung. Genau da kommt der Canvas ins Spiel.

Der Canvas beantwortet die drei oben genannten Kernfragen (Anforderungen in Abb. 4 mit grünlichem Hintergrund, Lösung mit blauem Hintergrund, Probleme mit rotem Hintergrund).

Der Business Context (fachliche Kontextabgrenzung) bildet den Übergang von Anforderungen zur Lösung, darum verläuft dieser Teil von grün nach blau.

Beispiele statt Details

Erstmal möchten wir den Canvas lediglich kurz vorstellen, ohne auf die detaillierte Bedeutung der einzelnen Elemente einzugehen. Diese können Sie bei Bedarf in der Online-Dokumentation nachlesen [6]. Stattdessen zeigen wir Ihnen ein paar Beispiele, damit Sie den Architecture Communication Canvas (wie er vollständig heißt) mal in "fertig" erleben können. Weiter unten finden Sie den Canvas als leeres Diagramm und auch ein paar Download-Links, mit denen Sie direkt loslegen können.

• Die Status- und Statistik-Subdomain von arc42 zeigt tabellarisch Statistiken von Besucher:innen und Seitenaufrufen der wesentlichen arc42-Domains. Dahinter steht eine in Go implementierte API, die verschiedene externe Auskünfte aggregiert.
• Eine Besonderheit dieses Systems ist die Kombination aus statisch generierter Website (auf Basis Jekyll und GitHub-Pages) mit dynamischem Content sowie einer geografisch verteilten Datenhaltung.

System zur Verwaltung von Gehältern

• gehalt.io ist die INNOQ-interne Anwendung für die Verwaltung von Gehältern.
• Das System wurde von vier Personen entwickelt, mit Java und Spring Boot. Eine klassische Web-Anwendung.

Massenmarkt CRM-System

• MaMa (für "Massenmarkt") ist eines der (zahlreichen) Systeme zum Management der elektronischen Gesundheitskarte. Die Kernaufgabe liegt in Beschaffung und Transfer der biometrischen Fotos der versicherten Personen, die auf diesen Karten aufgedruckt werden.
• Diese Version des Canvas stammt aus dem Juni 2023 – da waren die Größenverhältnisse der Schlüsselelemente (etwa: Stakeholder, Business-Context, Quality-Requirements) noch leicht anders als in der aktuellen Fassung.

System zur Rezeptempfehlung

• Selbst in Forschung und Lehre findet der Architecture Communication Canvas mittlerweile Anwendung. Hier das Beispiel einer Bachelor-Arbeit der Universität Osnabrück TheSta-24[7].
• Die Arbeit untersuchte die Wirksamkeit von Algorithmen eines "Recommendation Systems", konkret am Beispiel für personalisierte Empfehlungen für Kochrezepte.
• Die python-basierte Anwendung vergleicht, welche Kategorie von Recommender-Algorithmen besser den persönlichen Geschmack von Usern trifft.

Tool zur Überprüfung von HTML-Links

• Kleines Tool, welches die Links in einem HTML-Dokument hinsichtlich Gültigkeit und Dopplung überprüft
• Entwickelt von einer einzigen Person – Sie sehen, der Canvas eignet sich durchaus auch für kleine Projekte.

Abb. 11 zeigt ein Beispiel mitten aus einer solchen interaktiven Session: Das Team hatte gemeinsam eine Architektur-Kata durchgeführt und den Canvas dabei als zentralen Sammelpunkt für Vorschläge und Entscheidungen verwendet.

Falls Sie lieber elektronisch oder online arbeiten, gibt es den Canvas in folgenden Formaten:

• als Template für Miro[11]
• als Template für Mural [12]
• als Powerpoint-Version [13]– die Strukturelemente liegen dabei im Folienmaster. Gut geeignet für Meetings, in denen neben dem Entwicklungsteam auch fachliche Stakeholder mitarbeiten.
• als Vorlage für draw.io/diagrams.net[14]
• als PDF[15]