Architekturdokumentation: Ein Bild sagt weniger als 12 Worte

Dieser Artikel stammt aus unserem Blog, der nicht mehr betreut wird. Für Neuigkeiten zu oose und interessante Inhalte zu unseren Themen, folgt uns gerne auf LinkedIn.

Der Ausspruch "Ein Bild sagt mehr als tausend Worte" wird allgemein akzeptiert. Nicht immer transportiert ein Bild aber tatsächlich mehr Informationen als Text, oder kommuniziert sie effizienter. Nehmen Sie als Beispiel folgenden Satz:

Das System XY besteht aus den drei Subsystemen A, B, und C.

Alternativ könnte man diesen Sachverhalt auch als Aufzählungsliste darstellen.

Subsysteme von System XY:

• A
• B
• C

Das versteht jeder im XY-Projekt involvierte, vorausgesetzt er kann Deutsch und weiß, was ein Subsystem ist. Vergleichen Sie diese textuellen Darstellungen mit dem folgenden Bild, vielleicht eingebettet als Graphik in einem Wiki, dass Sie zur Dokumentation Ihrer Architektur nutzen.

[caption id="attachment_4010" align="aligncenter" width="300" caption="System XY besteht aus den drei dargestellten Subsystemen"][/caption]

Auf den ersten Blick ist die Abbildung hübsch anzuschauen und beinhaltet die gleichen Informationen wie der Satz oben. Für das Bild muss man die Notation verstehen, sie ist hier noch recht intuitiv. Wer die UML nur ein wenig kennt weiß wie viel Deutungsspielraum in dem Diagramm liegt. So könnte es beispielsweise noch weitaus mehr Subsysteme von XY im Modell geben, das Diagramm zeigt halt nur drei davon. Um das Abzusichern könnte man das Diagramm mit einem beschreibenden Text versehen, etwa wie in der Bildunterschrift bereits geschehen.

Das Diagramm liefert nun gegenüber dem ursprünglich zitierten Satz kaum einen Mehrwert.

Dieses Beispiel soll Sie keineswegs davon abhalten, ihre Architektur zu visualisieren. Es gibt aber durchaus Fälle, wo sie stattdessen eine textuelle Beschreibung zumindest in Erwägung ziehen sollten. So kann ein Ablauf unter Umständen auch in Pseudocode notiert werden, anstatt ein Sequenzdiagramm anzufertigen.

Graphische Darstellungen spielen ihre Stärken in Situationen aus, die über das bloße Aufzählen weniger Elemente wie oben herausgehen:

• Hierarchische Strukturen, Verfeinerungen
• Abläufe, insbesondere Alternativen, Wiederholungen, Parallelität
• Beziehungen zwischen Strukturelementen (z.B. auch Spezialisierung, Verwendung)
• Kategorisierung von Elementen, z.B. durch unterschiedliche Symbole
• Auszeichnen von Elementen und Anreichern mit Informationen
• Anordnen von Elementen in Gruppen, Schichten, …

Im speziellen Fall hier läge der Vorteil von UML weniger im oben gezeigten Diagramm, als in der Tatsache, dass es weitere Diagramme gibt, welche die selben Elemente z.B. in Interaktion oder im Einsatz zeigen. Das einheitliche Modell sorgt dann für Konsistenz, wenn z.B. etwas umbenannt wird.

Zum Abschluss noch eine kleine Aufgabe für Sie zur Anregung! Betrachten Sie die folgende Visualisierung von Klaviermusik (aka Noten, hier konkret aus Schwanensee). Finden Sie Elemente, die oben als Stärken für eine graphische Darstellung genannt sind, in Noten wieder?

[caption id="attachment_4013" align="aligncenter" width="640" caption="Visualisierung von Musik"][/caption]

Für den Fall, dass Sie keine Noten lesen können, hier ein paar Beispiele: die Parallelität der Hände (oben rechte Hand, unten linke), die Strukturierung in Takte, Anreichern mit Informationen (mf = Dynamik mezzoforte, Ziffern = beim Spiel zu verwendende Finger). Tatsächlich lassen sich sämtliche Punkte von oben aufzeigen.