Stefan Zörner
18.11.2015
Epilog der Blog-Serie. Wir diskutieren die Vorteile einer festen Glederung und kleben die Schnipsel danach zusammen.
In diesem Beitrag zeige ich Zusammenhänge zwischen den Schnipseln des Starschnitts auf und füge einzelne zu einem kleinen Architekturüberblick von Gradle zusammen. Während zuvor also jeweils eine Zutat im Vordergrund stand, ist es nun das (nicht ganz so) große Ganze. Und wir biegen in die Zielgerade ein …
In der letzten Folge der Serie hatte ich bereits Brettspiele als Beispiel für Dynamik und Abläufe herangezogen, wie sie die Laufzeitsicht für Softwaresysteme beschreibt. Derartige Spiele erfreuen sich in Deutschland großer Beliebtheit, nirgendwo erscheinen so viele pro Einwohner wie hierzulande. Der international gängige Begriff “German-style board game” illustriert das Phänomen – prominente Vertreter wie “Die Siedler von Catan” oder “Carcassonne” sind über die Brettspielkennerszene hinaus bekannt.
Die Szene trifft sich konsequenterweise alljährlich in Deutschland, genauer in Essen, zur größten Brettspielmesse der Welt – der “Spiel”. Dort wird neben anderen Preisen auch die Goldene Feder der Stadt Essen vergeben – für das Autorenspiel mit der besten Spielregel (!).
Ist Ihnen schon einmal aufgefallen, dass Spielregeln grundsätzlich den gleichen Aufbau haben? Zur Illustration sehen Sie oben eine Seite aus der Anleitung von Colt Express. Verallgemeinert sieht es in der Regel so aus:
Colt Express folgt diesem Muster ganz gut, inklusive Sonderregeln für zwei Spieler.
Die Vorteile eines festen Aufbaues und gleicher Elemente innerhalb der Spielregeln liegen auf der Hand:
Und ebenso wirken diese Vorteile auch bei der Gliederung von Architekturbeschreibungen. Nicht umsonst zählt “Verwende eine Standardstrukturierung” zu den sieben Regeln für gute Dokumentation. arc42 ist im deutschsprachigen Raum so etwas wie ein Defacto-Standard für derartige Strukturierungen (siehe hierzu auch “Ist dieses arc42 eigentlich alternativlos?").
Im Rahmen dieser Serie habe ich insgesamt 11 Zutaten einer Architekturdokumentation in Form von Schnipseln erklärt und anhand von Gradle illustriert. Die folgende Abbildung zeigt noch einmal, wo Sie die Schnipsel in einer Dokumentation gegliedert nach arc42 “abheften” würden.
Sicher fällt Ihnen auf, dass ich die Schnipsel nicht in der Reihenfolge besprochen habe, in der sie in der Gliederung stehen. Das passt dazu, dass das “Ausfüllen” von arc42 Abschnitt um Abschnitt ohnehin kein Erfolgsrezept ist. In der Praxis entstehen die einzelnen Zutaten anlass- und/oder risikogetrieben, werden im weiteren Projektverlauf verfeinert und ggf. auch massiv verändert. Erste Qualitätsszenarien fertige ich beispielsweise früh an, um die Qualitätsziele besser einschätzen zu können.
Um Ihnen Orientierung zu geben, wie sich die einzelnen Zutaten beeinflussen, illustriert das folgende graphische Glossar mit seinen Pfeilen wichtige methodische Zusammenhänge zwischen den Schnipseln. Das gibt Ihnen eine grobe Bearbeitungsreihenfolge und zeigt auch auf, wo sie auf Konsistenz und den roten Faden achten müssen. In einem guten Architekturüberblick beispielsweise sollten die Schnipsel kein Schüttgut sein, sondern eine Geschichte erzählen.
Wenn Sie eine Architekturdokumentation für ein bestehendes System “aus dem Nichts” anfertigen wollen, empfehle ich mit dem Systemkontext und dem Produktkarton zu beginnen. Der Systemkontext ist vor allem wichtig um zu klären, was eigentlich dazu gehört und was nicht.
Der Schlüssel, um einen wirkungsvollen Architekturüberblick anzufertigen, liegt darin die Zielgruppe klar herauszuarbeiten, und im Anschluss passend erste Zutaten auszuwählen und anzufertigen. Danach bringen sie diese in Form und holen sich Feedback von der Zielgruppe. In weiteren Iterationen arbeiten Sie die Rückmeldungen ein, nehmen bei Bedarf weitere Zutaten hinzu oder verfeinern bestehende.
Je nach Zielgruppe und Kommunikationsweg sind für einen Architekturüberblick sehr unterschiedliche Formen denkbar. Häufige Beispiele:
Gerade der Flyer ist eine spannende Form – durch die Beschränkung auf wenige Seiten (z.B. 4 Seiten DIN A4) bleibt es in der Regel tatsächlich bei einem Überblick. Wir bei embarc haben diese Form auch gewählt, um methodischen Wissen auf den Punkt zu bringen. Der erste dieser “Architekturspicker” hat passender Weise das Anfertigen eines Architekturüberblicks zum Thema (Abbildung siehe rechts). Sie finden ihn hier zum Download (4 Seiten DIN A4).
Für die häufig genutzte Form einer Folienpräsentation für einen Architekturüberblick enthält die folgende Tabelle einen Vorschlag zur Gliederung. Er ist grob nach dem 4-Quadranten-Modell gegliedert, das Sie im Schnipsel #9: Übergreifende Konzepte kennengelernt haben. Besonders wichtige Inhalte sind kursiv gesetzt.
| Architekturüberblick | ||
| Abschnitt I. Aufgabenstellung | ||
| Mögliche Inhalte | Passende Folgen der Serie | |
|
Mission Statement |
#1: Produktkarton |
|
| Abschnitt II. „The Big Picture“ |
Lösungsstrategie (Tabelle) |
|
| III. Die Lösung im Detail | ||
|
Architekturentscheidungen |
#5: Architekturentscheidungen |
|
| IV. Fazit und Ausblick | ||
|
Offene Punkte |
||
Ich habe einige Inhalte aus den vergangenen Beitragen zu Gradle zu einem entsprechenden Folienvortrag kombiniert. Sie finden Ihn hier:
Zum Weiterlesen
Meine arc42-Starschnitt-Serie bei Hanser Update geht mit diesem Beitrag zu Ende. Ich hoffe, Sie können die ein oder andere Anregung für Ihre tägliche Arbeit daraus mitnehmen. An dieser Stellen möchte ich mich noch einmal für die vielen Rückmeldungen bedanken, die ich zu dieser Serie erhalten habe. Sie sind weiterhin willkommen!
Dieser Beitrag ist ursprünglich als Teil einer Blog-Serie beim Hanser-Verlag (“Hanser Update”) erschienen. Die Inhalte, ergänzt um reichhaltiges Bonus-Material, sind mittlerweile auch als E-Book bei Leanpub verfügbar.