Category

Allgemein

embarc-echo-2-2017

embarc echo – II 2017

By | Allgemein, echo | No Comments

Impulse aufgreifen – embarc echo

Machine Learning, Architekturansätze unter der Lupe, die Anwendung von TypeScript in Bewegtbild („no slides, just code“), ein Ausflug zum Fantasy Football und Beispiele aus echten Ausgrabungen. Wie das zusammen passt? Kurzgefasst in unserem echo – Erfahrungswissen aus der Praxis mit nützlichen Anregungen und Links zu weiterführendem Lesestoff.

Download embarc echo II-2017 (PDF, 6 Seiten)

embarc_echo_1-2017 -- Klicken zum Download ...

bild_architectur_kata_SToth

Architektur Kata Live – Eine Rückschau

By | Allgemein, Inhaltliches, Publikationen, Vorträge | No Comments

Auf dem Software Architecture Summit 2017 in München habe ich einen halbtägigen Architektur Kata Workshop durchgeführt. Hier ein kurzer Einblick inklusive der erarbeiteten Ergebnisse und Präsentationsfolien. Mehr Informationen zu Architektur Kata gibt es auch in meinem Buch Vorgehensmuster für Softwarearchitektur

„Architektur Kata Live“
Logo Software Architecture Summit
 
Architektur Kata Live
Sprecher: Stefan Toth
Halbtagsworkshop auf dem Software Architecture Summit, München
Dienstag, 14. März 2017, 10 – 13 Uhr
Novotel München Messe, Willy-Brandt-Platz 1, 81829 München Riem

Was ist Ihrer Meinung nach wichtig, um als Sportler Erfolg zu haben? Genetische Veranlagung? Talent? Geld? Glück? Je nach Sportart werden diese Dinge mehr oder weniger Einfluss haben, fest steht jedoch: Alle Sportler trainieren und steigern ihre Leistungsfähigkeit zwischen den Wettkämpfen. Auch Tänzer, Moderatoren oder Musiker bereiten sich professionell auf ihre Aufgaben vor – sie tanzen, machen Sprechübungen, lernen oder proben. In Architektur Kata wird diese Professionalität auf Softwarearchitektur übertragen. Das Konzept der „Kata“ ist dabei Kampfsportarten entliehen, die damit die wiederholte Ausführung von Bewegungsabläufen im Übungsumfeld bezeichnen, um im Ernstfall gerüstet zu sein.
Was wir auch in Projekten und Firmen schon gemacht haben, wurde nun auf die große Teilnehmergruppe am Architecture Summit adaptiert. Über fast 70 Teilnehmer zwängten sich in einen etwas zu kleinen Raum und erhielten die Möglichkeit Systeme zu entwerfen, technisch relevante Fertigkeiten einzusetzen und ihre Ideen kreativ festzuhalten. Wiederholt, abwechslungsreich und im Vergleich mit anderen.

Die ausgewählten Architektur Kata waren „Real Fantasy NFL“ und „Lights, please“. Beide direkt von der ehemaligen Webseite des Erfinders Ted Neward (Teds Kata Seite) und sehr unterschiedlich. Einmal geht es um eine hochskalierbare und äußerst elastisch umzusetzende Webseite für Fantasy Football inkl. Highlight Videos, einmal um Heimautomatisation und die damit zusammenhängenden Herausforderungen für einen Elektronikartikelhersteller.
In Gruppen arbeiteten die Teilnehmer insgesamt etwa 1:15 an ihrer Lösung und an ihrem Problemverständnis. Lösungen wurden gegenseitig vorgestellt und bewertet. Hier die Gruppenergebnisse:

Hier gibt’s noch die Folien der Session zum Download.

bild_echo_1_2017_cover

embarc echo – I 2017

By | Allgemein, echo | No Comments

Impulse aufgreifen – embarc echo

Finden Sie in gewohnt kurzer Form frische Anregungen aus unseren Konferenzbeiträgen, Fachartikeln und neuem Bewegtbildmaterial.

Lassen Sie sich von Kundengeschichten aus unserem Projektalltag inspirieren und umgehen Sie die fünf häufigsten Stolperfallen beim Einsatz von Microservices. Apropos Stolperfallen… Sie erinnern sich noch an die Arcade-Aliens, die es auf Atari & Co. abzuwehren galt? Sie haben überlebt! „Game on!“

Download embarc echo I-2017 (PDF, 7 Seiten)

embarc_echo_1-2017 -- Klicken zum Download ...

Drei Dinge, die mich bei Architekturdiagrammen mit plantUML nerv(t)en

By | Allgemein, Inhaltliches | 8 Comments

plantIch sehe bei Kunden ab und an plantUML im Einsatz. Und noch häufiger fragen mich Teilnehmer in Workshops, was ich von plantUML halte, wenn es um Diagramme in der Dokumentation von Softwarearchitektur geht. Beispielsweise in den betreffenden Abschnitten von arc42 (Konkret: Kontextabgrenzung, Bausteinsicht, Laufzeitsicht …).

Um ehrlich zu sein fand ich plantUML dafür lange Zeit nicht so toll. Aus verschiedenen Gründen. Bei näherem Hinsehen ließ sich einiges davon aber auf Unkenntnis und Vorurteile meinerseits zurückführen. Und einige Unschönheiten lassen sich mit den richtigen Kniffs und Workarounds umgehen. Ein paar kleine Erkenntnisse zeige ich im Rahmen dieses Beitrags. Und beginne so meinen Frieden zu machen mit dem Werkzeug.

Aber zuvor: Was ist dieses plantUML überhaupt (für diejenigen, die es nicht kennen) und warum finde ich es (immernoch) nicht ganz so toll wie manche meiner Kunden?

plantUML

plantUML generiert UML-Diagramme als Graphik aus textuellen Beschreibungen. Die Syntax dazu ist recht einfach gehalten und schnell erlernt. Hier ein Minibeispiel. Aus der Eingabe links generiert plantUML das Diagramm rechts.cd_schach

@startuml

Schachbrett -> Figur 
Figur --> Farbe
Figur --> enum Art

enum Farbe { 
 SCHWARZ 
 WEISS
}

@enduml

 

Neben den besonders gut unterstützen Klassendiagrammen (wie im Beispiel oben, Details zur Syntax siehe hier) kann plantUML auch andere Diagrammarten der UML generieren (Sequenzdiagramme, Anwendungsfalldiagramme …).

plantUML ist Open Source, in Java geschrieben und leicht integrierbar. Entsprechend gibt es zum Beispiel Plugins für verschiedene Textsysteme (z.B. Asciidoctor), Build-Werkzeuge (z.B. Gradle) und Wikis (z.B. XWiki und Confluence). Gerade in diesen Fällen passt das Text-Format von plantUML sehr gut, fühlt es sich doch in der Versionsverwaltung ebenso wohl wie zwischen Wiki-Markup.

In der Regel nimmt der Autor beim Erstellen kaum Einfluss auf das Layout seiner Diagramme. Ich sehe das als Vorteil, kostet das Kästchenschubsen in graphischen Editoren bei Änderungen doch oftmals viel Zeit.

Drei Dinge, die ich an plantUML nicht mag

Trotz der unbestrittenen positiven Merkmale gibt es Dinge, die mir bei plantUML nicht so gut gefallen. Hier drei aus meiner Sicht besonders gewichtige:

  1. Der Technologie-Stack ist fragil
  2. Für Softwarearchitektur relevante Diagramme fehlen
  3. Die generierten Diagramme sehen altbacken aus

Der Technologie-Stack ist fragil

plantUML ist in Java geschrieben, der Download lediglich ein jar-File. Tatsächlich handelt es sich bei bei dem Tool aber eher um ein Frontend (oder wenn man mag einen Präprozessor) für das Werkzeug Graphviz.

binaryGraphviz ist eine leistungsfähige und recht verbreitete Open Source-Lösung zum Visualisieren von Graphen (also Knoten verbunden durch Kanten). Anders als plantUML wird es Betriebssystem-spezifisch als Binary installiert. Es muss lokal vorliegen (konkret: das Graphviz-Executable „dot“). plantUML greift darauf zu, es verwandelt die plantUML-Eingabe in eine Eingabe in der DOT-Sprache und lässt dann Graphviz die ganze Arbeit machen („Zwerge auf den Schultern von Riesen“).

Das Problem dabei: das Zusammenspiel zwischen plantUML und dot führt regelmäßig zu Reibung. Auch eine saubere Graphviz-Installation verweigert schon mal die Arbeit und führt zu Fehlermeldungen, lustigerweise in Form einer Graphik anstelle des erhofften Ergebnisses. Sieht dann zum Beispiel so aus:

Fehler beim Aufruf von not / Graphviz

In der Praxis heißt das etwa für ein Java-Projekt, das seine Architekturdokumentation in den Build integrieren will, dass es höhere Anforderungen an das Build-System stellt. Also an alle, die das Projekt bauen wollen. Java installieren reicht nicht (wie bei Gradle durch den Wrapper eigentlich üblich), es muss auch noch Graphviz da sein und mit plantUML zusammenspielen.  Das berühmte „It Works on My Machine“ war doch eigentlich überwunden (OK, die Pest ist schlussendlich auch noch nicht ausgestorben). Auch entsprechende Beiträge der Plugin-Benutzer in den Foren von XWiki und Confluence singen ein Lied von dem Problem.

Für Softwarearchitektur relevante Diagramme fehlen

plantUML unterstützt verschiedene Diagrammarten der UML, und die wiederum verschiedenen gut. Bei Klassendiagrammen geht mit Abstand am meisten. Gerade diese Diegrammart benötige ich allerdings in einem Architekturüberblick eher selten, bestenfalls für ein grobes Domänenmodell.

struktur_kleinBesonders wichtig sind mir methodisch gesehen die Kontextabgrenzung (Kapitel 3 in arc42, bzw. der Abschnitt „Context“ bei Simon Brown) und die statische Zerlegung (Kapitel 5 „Bausteinsicht“ in arc42). Eine Kontextabgrenzung lässt sich mit plantUML ganz gut visualisieren übrigens. Meine favorisierte Darstellung von Zerlegungshierarchien mit den Ports der Kompositionsstrukturdiagramme unterstützt plantUML leider nicht. Strukturen lassen sich zwar mit gruppierenden Elementen abbilden; Interaktionspunkte auf der „Membran“ (Ports, siehe kleine Skizze links) gehen hingehen nicht.

Die Diagramme sehen altbacken aus

Geschmäcker sind verschiedenen, mir persönlich gefällt die Darstellung von plantUML tatsächlich nicht sonderlich. Die Buchstaben-Icons bei Klassen, Aufzählungen etc. (E, C, … siehe Schach-Beispiel oben)  sind nicht mein Fall, und vor allem:  Die Farben (gelbe Kästen, rote Linien) haben die Anmutung alter Rational-Werkzeuge (kleine Zeitreise, Video). Die Zeit wünsche ich mir nicht zurück. Den Retro-Look der 90er-Jahre komplett machen dann Komponenten im Stil der UML 1. Als Beispiel hier ein rudimentärer Systemkontext (System mit einem Benutzer als Akteur) in plantUML, rechts wieder das resultierende Diagramm (das System als Komponente in UML 1-Notation):

@startumlsc_altbacken
[Webshop] <<system>>
:Kunde: - Webshop
@enduml

Auf Diagramme mit dieser Anmutung stolpere ich regelmäßig in Projekten. Dass mir die nicht übermäßig gefallen ist mein Problem, wenn die Teams es so mögen … Mein Problem könnt Ihr gleichzeitig beheben, bei plantUML läßt sich nämlich so ziemlich jede Stileigenschaft (Fonts, Farben, Strichbreiten …) konfigurieren. Aber wer hat da schon Lust zu? Der Aufwand mit all den Schaltern schreckt erstmal ab.

Die gute Nachricht: Es gibt recht große Schalter — Hebel sozusagen — welche mit wenig Aufwand viel Wirkung zeigen. Für das Beispiel oben reichen zwei dieser wirkmächtigen Hebel, und es sieht für mich deutlich passabler aus (siehe wieder Graphik rechts):

@startumlsc_modern
skinparam monochrome true
skinparam componentStyle uml2

[Webshop] <<system>>
:Kunde: - Webshop
@enduml

Das gefällt mir richtig gut schon. Derartige Skin-Parameter lassen sich übrigens auch in Dateien auslagern, von aussen in den plantUML-Prozessor reinreichen, etc. — So verschmutzen sie auch nicht alle plantUML-Quelltexte.

Fazit

Der Ansatz, aus text-basierten Beschreibungen Graphiken/Diagramme zu generieren, hat viel für sich. In vielen Fällen nutzen Teams ein Wiki oder Text-Systeme wie Asciidoc, um ihre Architekturdokumentation festzuhalten. Die Frage, wo die Diagramme herkommen, stellt sich dort stets, und plantUML ist zumindest eine Option. Mit wenigen Kniffen finde ich die Ausgabe zumindest optisch passabel, eine große Herausforderung bleibt das fragile Zusammenspiel mit Graphviz.

Ich spiele mit dem Gedanken hier ein geschlossenes Fallbeispiel bereitzustellen. Einen Architekturüberblick, in dem die Diagramme mit plantUML generiert sind, und dessen Inhalte sich an den Sichten von arc42 orientieren. Fänden Sie das interessant?

Treffpunkt für Softwarearchitekten – embarc auf dem Architecture Gathering 2016

By | Allgemein | No Comments

Nach der Premiere im letzten Jahr fand das Architecture Gathering dieses Jahr im Oktober erneut in München statt und erfreute sich zahlreicher Besucher. Wir waren mit zwei Vorträgen & unserem Stand auf der Konferenz dabei.

Harm Gnoyke gab in seinem Vortrag ganz praktische Tipps wie Sie Ihren Monolithen möglichst charmant in ein Microservices-System verwandeln. Dabei ergaben sich unterhaltsame Parallelen zwischen den Beziehungen von Projektteams zu ihren Softwarelösungen und den Trennungsphasen des realen Lebens. Ja und selbst die Aufnahmen des Titelhelden (Matthew McConaughey) passten sich im Verlauf der Session dem leichtgewichtigeren Architekturstil an… also ein wenig zumindest (Folieneinblicke).

Unsere Session von Oliver Zeigermann lud am zweiten Veranstaltungstag zum Erfahrungsaustausch zu Best-Practices in der Web-Entwicklung ein und zeigte wo deren Grenzen liegen. Mittels einer kurzen Filmsequenz gab es Einblicke in die Gefühlswelt eines Entwicklers (beim 2-Wege-DataBinding) und am Ende beantwortete Oliver nicht nur die Frage aus „Wissen-20“, sondern noch einige mehr… (nachzulesen auf github).

Gute Gespräche und Austausch am embarc-Stand und auf der Konferenz rundeten den Besuch für uns in München ab und ließen zudem jede Menge frisch gedruckter Architektur-Spicker schwinden.

Aber Bilder sagen ja bekanntlich mehr als Worte…

 
 
(Fotos: SigsDatacom, embarc)

Die sieben Regeln für gute Dokumentation in Stein gemeißelt? — Tafel 3 (von 3)

By | Allgemein, Inhaltliches | No Comments

In den zwei vorherigen Beiträgen hatte ich bereits mit der kurzen Diskussion der klassischen sieben Regeln für gute Dokumentation begonnen. Ich schließe sie in diesem Beitrag mit den beiden verbleibenden Regeln 3 und 7 ab. Hier noch einmal kurz zur Erinnerung alle sieben im Überblick:

Sieben Regeln für gute Dokumentation
book
1. Schreibe aus Sicht des Lesers. (Tafel 1)
2. Vermeide unnötige Wiederholungen. (Tafel 2)
3. Vermeide Mehrdeutigkeit. Erkläre Deine Notation. (Tafel 3)
4. Verwende eine Standardstrukturierung. (Tafel 2)
5. Halte Begründungen für Entscheidungen fest. (Tafel 1)
6. Halte Dokumentation aktuell, aber auch nicht zu aktuell. (Tafel 2)
7. Überprüfe Dokumentation auf ihre Gebrauchstauglichkeit. (Tafel 3)

Vermeide Mehrdeutigkeit. Erkläre Deine Notation (Regel 3)

Es ist unstrittig, dass sich bestimmte Informationen mit Bildern besser kommunizieren lassen als mit Text allein. Das gilt für Strukturen (Elemente und deren Beziehungen untereinander) ebenso wie für Abläufe (Folgen von Aktionen mit Alternativen, Wiederholungen, Parallelität). Ab einer gewissen Komplexität lässt sich das mit Stichpunkten oder Prosa nicht gut beschreiben. Diagramme und mitunter auch Screenshots kommen ins Spiel, bei Diagrammen ist in der Softwarearchitektur immer noch UML recht verbreitet.

In diesem Zusammenhang höre ich in Projekten oft: „Wir benutzen für unsere Architekturdiagramme UML. Die Notation ist standardisiert. Kann jeder lesen.“ Das mit dem standardisiert stimmt, meine Erfahrungen mit „kann jeder lesen“ sind andere.

In der Projektpraxis werden übrigens oft gar keine Architekturdiagramme angefertigt. Auch weil die Teammitglieder unsicher in der Notation sind. Sie glauben sie müssten UML nehmen aber haben Angst sich damit zu blamieren. Aus meiner Sicht ist UML zu verwenden kein Automatismus, und bei den vielen Zielgruppen (vgl. Regel 1) wird auch bei der UML Erklärungsbedarf da sein.

In diesem Zusammenhang zwei persönliche Ratschläge von mir rund um Diagramme:

  • Schreibt zu jedem Diagramm einen Satz der auf den Punkt bringt was zu sehen ist (“Mission Statement”, Kernaussage). In der Dokumentation (egal ob Dokument, Wiki, Poster …) platziert Ihr diesen Satz oberhalb der Abbildung.
  • Lasst Euch nicht von der Notation behindern. Benutzt stattdessen wenige Elemente, und erklärt diese in einer Legende.

Der erste Tipp sorgt zum einen dazu, dass Betrachter nicht rätseln müssen, was Ihr mit dem Bild sagen wollt. Zum anderen (und das ist das Entscheidende) hilft es Euch zu entscheiden, ob etwas „noch ins Bild reingehört“ oder nicht. Ihr vermeidet Diagramme voller Prachtfülle, in denen der Leser die relevanten Informationen dann aber suchen muss wie in einem Wimmelbild. Hier ein schönes Fundstück aus dem Netz dazu (Quelle, beachtet die beschönigende Überschrift).

complex-system-architecture-diagram-2292510

Immerhin: Eine Legende hat dieses Diagramm. Die Regel „Erkläre Deine Notation“ wende ich durchaus auch auf UML an. Und wenn Ihr dort wenige Elemente verwendet braucht Ihr auch nur wenig erklären. Die wenigen UML-Elemente dann aber bitte richtig verwenden. Sonst verwirrt Ihr diejenigen, die UML lesen können (gibt es auch).

Überprüfe Dokumentation auf ihre Gebrauchstauglichkeit (Regel 7)

Hinter dieser Regel stecken Reviews, zumindest suggeriert das Wort „überprüfen“ das. Dokumentation kann man auf zwei Arten überprüfen. Die erste nenne ich gern „Überprüfung auf Standardkonformität“. Hier werden Kriterien an die Dokumentation gelegt und Fragen folgender Art gestellt (Beispiele):

  • Hat die Architekturbeschreibung mindestens 60 Seiten?
  • Ist sie nach arc42 gegliedert?
  • Ist jeder Abschnitt ausgefüllt?
  • Wird für die Diagramme als Notation UML verwendet?
  • Hat jedes Diagramm eine Legende?

Fragen dieser Art eignen sich prima für Checklisten, diese können in der Regel von einer QS-Abteilung abgearbeitet werden. Mitunter erfordern regulative Randbedingungen einen solchen Check auf Standardkonformität. Mit der Überprüfung auf Gebrauchstauglichkeit ist aber etwas anderes gemeint.

Nämlich dass die Dokumentation tatsächlich bei der Arbeit unterstützt. Diejenigen, welche Architektur kommunizieren wollen, und diejenigen, welche sich dafür interessieren. Also für Architekturtreiber, Lösungsansätze, Entscheidungen, Konzepte. Die geschlossenen Fragen von oben können das nicht leisten.
Architektur-Spicker #1, Seite 3
Die Überprüfung auf Gebrauchstauglichkeit findet als Test mit den Zielgruppen statt. Und hier schließt sich der Kreis von Regel 7 zu Regel 1 („Schreibe aus Sicht des Lesers“). Das Anfertigen eines Architekturüberblicks stelle ich überhaupt gerne als Kreislauf dar (initial klein Starten, dann schrittweise Verfeinern). Eine Darstellung dieser Idee findet Ihr zum Beispiel in unseren Architektur-Spicker #1 („Der Architekturüberblick“, Download als PDF) auf Seite 3 oben.

Die sieben Regeln für gute Dokumentation in Stein gemeißelt? — Tafel 2 (von 3)

By | Allgemein, Inhaltliches | No Comments

In einem früheren Beitrag hatte ich bereits mit der kurzen Diskussion von zwei der sieben Regeln für gute Dokumentation begonnen. Hier geht es weiter. Nochmal kurz zur Erinnerung alle Regeln im Überblick:

 

book

1. Schreibe aus Sicht des Lesers. (Tafel 1)
2. Vermeide unnötige Wiederholungen. (Tafel 2)
3. Vermeide Mehrdeutigkeit. Erkläre Deine Notation.
4. Verwende eine Standardstrukturierung. (Tafel 2)
5. Halte Begründungen für Entscheidungen fest. (Tafel 1)
6. Halte Dokumentation aktuell, aber auch nicht zu aktuell. (Tafel 2)
7. Überprüfe Dokumentation auf ihre Gebrauchstauglichkeit.

Starten möchte ich mit einer Regel die falsch angewendet sogar richtig Schaden anrichten kann. Der vierten.

Verwende eine Standardstrukturierung (Regel 4)

Wenn Ihr Dokumentationszutaten über den Quelltext hinaus anfertigt (beispielsweise Schritt-für-Schritt-Anleitungen zu übergreifenden Themen wie Persistenz oder Security) stellt sich die Frage wo Ihr das Ganze ablegt und strukturiert. Dies vierte Regel wird gerne als Reklamesatz für arc42 herangezogen. arc42 stellt eine Standardgliederung für Architekturbeschreibungen dar (in D-A-CH De-facto-Standard).
list-2
Tatsächlich findet alles irgendwie seinen Platz in arc42 (der Abschnitt „Konzepte“ entpuppt sich dabei in der Praxis als Joker). Ich rate Euch aber davon ab, Architekturdokumentation initial anzufertigen, in dem Ihr eine vollständige arc42-Gliederung (immerhin 12 Abschnitte) geschlossen z.B. als Word-Dokument „ausfüllt“.

Den Wert von arc42 sehe ich vor allem im Nennen möglicher Zutaten einer Dokumentation, die zusätzlich zum Quelltext im Team entstehen. Die Kontextabgrenzung etwa, oder Qualitätsziele. Hier gibt es übrigens große Überdeckungen zu Alternativen. Die arc42-Gliederung selbst hat dann ihren großen Auftritt, wenn Ihr eine Architekturbeschreibung aus den einzelnen Bestandteilen für eine bestimmte Zielgruppe zusammen setzt. Darüber hinaus hilft die Struktur auch beim Verwalten der Teile.

Standardgliederungen funktionieren übrigens auch in kleinerem Rahmen gut. Muss nicht gleich die ganze Architekturbeschreibung sein. Beispielsweise bei Schnittstellen und Entscheidungen ist die immer gleiche Struktur hilfreich. Sie gibt den Erstellern Sicherheit und Orientierung. Im Falle von Architekturentscheidungen unterstützt sie auch das Treffen derselben (die Dokumentation fällt ab). Dieser Beitrag enthält eine praxisbewährte Gliederung für Architekturentscheidungen.

Der Schaden, den diese vierte Regel nun anrichten kann, entfaltet sich in Kombination mit der nächsten.

Vermeide unnötige Wiederholungen (Regel 2)copy

Beim Nachdenken über diese Regel stolpere ich über das Wort „unnötig“. „Don’t repeat yourself“ ist ein prominentes Prinzip (auch DRY). Wenn hier explizit von „unnötigen“ Wiederholungen die Rede ist, scheint es auch solche zu geben, die nötig oder zumindest OK sind. DRY gibt mehr Orientierung … Was will und Regel 4 sagen?

Falls Ihr Architekturdokumentation wie oft gesehen in einem arc42-Dokument in Word anfertigt, geratet Ihr bei Anwendung von „Schreibe aus Sicht des Lesers“ (Regel 1) in ein Problem: Ein einziges Dokument  wird mehrere Zielgruppen nicht gerecht. Widersteht dem Reflex, einzelne Dokumente für die jeweiligen Zielgruppen anzufertigen (gute Idee eigentlich), und die betreffenden Inhalte dann jeweils hinein zu kopieren (schlechte Idee). Ihr lauft Gefahr, dass sich die geklonten Inhalte unabhängig voneinander ändern, und/oder habt hohe Wartungsaufwende.

Fertigt die Inhalte stattdessen jeweils einmal kleinteilig an, und führt sie bei Bedarf in unterschiedlichen  Dokumenten oder anderen Formen zusammen. Am besten geht dies automatisiert, etwa im Rahmen des Build-Prozesses. In der Projektpraxis sehen wir als Formate hier eher Markdown oder (häufiger) AsciiDoc als Word. Diese fühlen sich in einer Versionsverwaltung wohl; diff und merge funktionieren prima. Mit Hilfe von Includes entstehen passende Dokumente für unterschiedliche Zielgruppen durch Rekombinieren der Inhalte. Dieser Beitrag stellt eine entsprechende Werkzeugkette mit Markdown und Maven bzw. alternativ Gradle vor.

Ebenso wie einzelne Architekturdokumentation für unterschiedliche Zielgruppen durch Cut/Copy/Paste zu erzeugen solltet Ihr keine umfangreichen Inhalte aus anderen Teilen der Dokumentation (Klassiker: Anforderungen) in Eure Dokumentation kopieren. Verweist auf sie. OK ist aus meiner Sicht eine knappe Zusammenfassung, um den Lesern das Verfolgen des Links zu ersparen, die nur einen Überblick haben wollen. Hier handelt es sich um einen Kompromiss zwischen leichter Lesbarkeit und Wartbarkeit. Das führt zu Wiederholungen, die im Sinne der Regel OK sind.

Halte Dokumentation aktuell, aber auch nicht zu aktuell (Regel 6)file-2

Veraltete Dokumentation ist häufig eine Ausrede um überhaupt nicht zu dokumentieren. Dahinter stecken zwei Annahmen:

  1. Dokumentation veraltet sowieso
  2. Veraltete Dokumentation ist wertlos

Dazu lässt sich sagen: Eine festgehaltene (Architektur-)Entscheidung veraltet keineswegs, solange Ihr nicht von ihr abweicht. Vielleicht würdet Ihr heute anders entscheiden, mittlerweile haben sich Rahmenbedingungen oder Ziele geändert, Optionen sind dazugekommen, Annahmen haben sich als falsch herausgestellt. Kurz: Ihr seid schlauer. Um die Entscheidung nachvollziehen zu können ist aber der Zeitpunkt der Entscheidung relevant. Und da Architekturentscheidungen typischerweise schwer zurückzunehmen sind, ist eine spätere Umentscheidung unwahrscheinlich. Wenn Eurer Team in bestimmten Ausnahmefällen von dieser Entscheidung abweicht, ist es erst recht lohnenswert, diese Tatsache festzuhalten und das Wissen darum zum Beispiel an Neue weiterzugeben. Merke: Dokumentation unterstützt Kommunikation.

Neben den dokumentierten Entscheidungen gehören vor allem Lösungskonzepte und Mittel, die es leichter machen im Quelltext zurecht zu finden, in Eure Architekturdokumentation. Zu letzteren gehören Diagramme, die Strukturen und Abläufe zeigen (ungeliebte und unangefochtene Notation: UML). Die Wahrscheinlichkeit, dass Konzepte und Diagramme veralten, nimmt mit dem Detaillierungsgrad zu.

Veraltete Dokumentation weicht von der Lösungsrealität (dem Quelltext) ab. Das Team hat Änderungen und Ergänzungen also nicht nachgezogen.

Ich lese diese Regel daher vor allem so: Wenn Ihr merkt, dass Ihr viel Aufwand zum Nachziehen betreiben müsst, fragt Euch, ob dieser in einem gesunden Verhältnis zum Nutzen steht. Falls nein: Abstrahieren oder Automatisieren:

  • Abstrahieren — die Dokumentation beschreibt keine Lösungsdetails, sondern liefert einen Überblick
  • Automatisieren — Teile der Dokumentation werden z.B. im Rahmen des Builds aus dem Quelltext abgeleitet

Und die anderen Regeln?

In einem weiteren Beitrag hier im Blog führe ich die Diskussion mit den verbliebenen zwei Regeln fort. Bleibt dran …

embarc echo – Juli 2016

By | Allgemein, echo | No Comments

Frische Einblicke & Nützliches in Kürze – embarc echo

Entdecken Sie brandneue Erstauflagen und erleben Sie Interviews zu Stolperfallen und anderen Chancen. Lassen Sie sich von unseren Projekteinsätzen inspirieren, greifen Sie Impulse auf und finden Sie Anregungen in aktuellen Veröffentlichungen.
Auch im zweiten Halbjahr werden wir wieder auf Konferenzen und bei User Groups in ganz Deutschland ‚on tour‘ sein – unsere Landkarte bringt die nächsten Stationen auf einen Blick zusammen. Neben neuem Lesestoff gibt es dieses Mal noch ein kleines Goodie für unsere echo-Leser – viel Spaß beim Finden!

Download embarc echo II-2016 (PDF, 6 Seiten)

embarc_echo_7-2016 -- Klicken zum Download ...

Wie sehen iSAQB CPSA-Advanced Prüfungsaufgaben eigentlich aus?

By | Allgemein, Inhaltliches | No Comments

diploma-3Der iSAQB-Einstiegslevel Foundation der Certified Professional for Software Architecture-Zertifierung (kurz: CPSA-F) sieht einen Multiple Choice Test als Prüfung vor. Bei der zweiten Stufe, dem Advanced Level, bearbeitet der Prüfling hingegen eine Hausarbeit. Seine Lösung verteidigt er (bzw. sie) dann im Rahmen eines Interviews vor zwei Prüfern, die diese vorher durchgesehen und gegen Kriterien gehalten haben.

Beim Multiple Choice Test (CPSA-F) ist relativ klar, was auf den Prüfling zukommt. Auch wenn einzelne Lernziele mit Ankreuzfragen nur schwer überprüfbar sind, und man sich konkrete Fragen vielleicht nur schwer vorstellen kann, gilt das zumindest für die Form der Prüfung. Zum Advanced-Level höre ich in Workshops oder per Mail dagegen immer wieder die Frage: Wie sieht eine solche Prüfungsaufgabe inhaltlich aus? Das ist nicht unmittelbar klar.

Nun sind die Prüfungsaufgaben selbst natürlich vertraulich (genau wie der Prüfungsfragen im Foundation Level). Vorlagen und Checklisten zur Erstellung von Aufgaben sind jedoch frei zugänglich (auf der Webseite des iSAQB). Sie sind nicht unbedingt leicht verdaulich — falsche Zielgruppe: sie sind für Leute gedacht, die sich neue Aufgaben ausdenken. Ich beschreibe daher im Folgenden mal, wie Aufgaben aufgebaut sind – für Leute, die demnächst ein solche Aufgabe lösen müssen. Was Sie als Advanced-Prüfling also grob erwartet…

Überblick Prüfungsaufgabe

Wie sieht eine Aufgabe grundsätzlich aus?

Die Aufgabenstellung einer Prüfungsaufgabe für CPSA-Advanced umfasst mindestens 10 Seiten und höchstens 25 (siehe Abbildung rechte, die Seitenzahlen sind Beispielwerte).

Jede Aufgabe ist einer Systemart zugeordnet. Aktuell sind das

  • Informationssystem
  • Embedded System
  • Websystem

Ein Kandidat gibt bei der Anmeldung zur Prüfung die gewünschte Systemart an und erhält dann eine Aufgabe aus diesem Bereich. Damit soll verhindert werden, dass ein Prüfling mit einer Umfeld konfrontiert wird. das ihm völlig fremd ist. Darüber hinaus ermöglicht ein kurzer Abstract (2-3 Sätze) zur Aufgabenstellung dem Prüfling zu entscheiden, ob die Aufgabe grob passt.

Jede Aufgabe selbst zerfällt dann in zwei grobe Blöcke: Ein Fallbeispiel in Form inhaltlicher Inputs, und die Aufgabenstellung selbst. Letztere ist in Teilaufgaben gegliedert. Die konkreten Prüfungsaufgaben variieren dabei in der Zusammenstellung der inhaltlichen Inputs und den Teilaufgaben.

Das Fallbeispiel

Prüfungsaufgaben: FallbeispielBeim Fallbeispiel handelt es sich um ein fiktives Projekt, eine Produktentwicklung, eine Migration oder ähnliches. Nach einem kurzen Überblick liegen konkrete Informationen dazu in Form inhaltlicher Inputs vor. Im Wesentlichen sind das Anforderungen, die der Prüfling in den späteren Teilaufgaben berücksichtigen muss. Denkbar sind etwa folgende Inhalte:

  • Funktionale Anforderungen (z.B. wichtige Use Cases, User Stories, …)
  • Qualitätsziele, ggf. verfeinert in Szenerien
  • Stakeholder (z.B. Liste, Personas)
  • Interviews mit Stakeholdern
  • Technische und/oder organisatorische Rahmenbedingungen
  • Fachlicher Kontext, Benutzer und Fremdsysteme
  • Normen und Konventionen
  • Risiken

Nicht jede Aufgabenstellung enthält dabei alle diese Inhalte. Weiterhin kann es sein, dass bestimmte Anforderungen explizit genannt sind, andere jedoch im Rahmen der Aufgabe erarbeitet werden müssen. Beispielsweise liegen Interviews mit Stakeholdern vor, und die Rahmenbedingungen oder Qualitätsziele muss der Prüfling dann im Rahmen einer Teilaufgabe herausarbeiten und ggf. priorisieren.

Ihre Aufgabe

Prüfungsaufgaben: TeilaufgabenGanz ähnlich wie das Fallbeispiel mit seinen inhaltlichen Inputs ist auch die Aufgabe unterteilt — in mindestens 5 und maximal 10 Teilaufgaben, die unterschiedliche Aspekte der Architekturarbeit abdecken. In Summe soll die Bearbeitung zeigen, dass der Prüfling in der Lage ist, aus Anforderungen methodisch eine Architektur zu entwerfen und festzuhalten, sie zu reflektieren und zu kommunizieren. Analog zu den denkbaren Inputs oben beim Fallbeispiel hier mögliche Teilaufgaben:

  • Kontext abgrenzen
  • Qualitätsziele identifizieren, Qualitätsbaum und -szenarien erarbeiten
  • Offene Fragen an Stakeholder formulieren
  • Lösungsstrategie/Architekturvision anfertigen
  • Architekturentscheidungen treffen
  • Technische Fragestellung inkl. Alternativen und Begründung bearbeiten
  • System strukturieren, fachlich zerlegen, Verantwortlichkeiten festlegen
  • Schnittstellen entwerfen
  • technische und/oder übergreifende Aspekte bearbeiten
  • Lösung qualitativ bewerten
  • Risiken identifizieren und adressieren

Es gibt dabei Überschneidungen in inhaltlichen Inputs und Teilaufgaben: Der Systemkontext könnte etwa mit dem Fallbeispiel gegeben sein (als inhaltlicher Input) oder muss alternativ als Teilaufgabe erarbeitet werden.
Prüfungsaufgaben: FAQ

Häufige Fragen zu Prüfungsaufgaben

Wie wird sichergestellt, dass die Aufgabe zu den von mir besuchten Schulungen passt?

Eigentlich gar nicht. Durch die Angabe der Systemart (z.B. Web, Embedded) wird lediglich abgesichert, dass es technologisch grob passt. Ansonsten sind die Aufgaben nicht an bestimmte Module gebunden. Die Teilaufgaben (+ Interview) decken lediglich die drei Kompetenzbereiche („Säulen“) des Advanced-Levels ab.

Welchen Umfang hat meine Lösung?

Sie halten Ihre Lösung auf maximal 40 DIN A4-Seiten (inklusive Abbildungen) fest. Dazu haben Sie maximal 3 Monate Zeit (Details siehe Prüfungsordnung). Vom Aufwand sind die Teilaufgaben so bemessen, dass ein Prüfling sie in 40 Stunden erledigen kann.

Was wenn Technologien oder Methoden gefordert sind, die ich nicht beherrsche?

Die Aufgabenstellungen lassen Ihnen angemessenen Spielraum bezüglich Technologien, Werkzeugen, Notation und Ähnlichem. Wenn etwas explizit gefordert ist, so ist sichergestellt, dass Informationen dazu frei zugänglich sind. Entweder es liegt der Aufgabe bereits in den inhaltlichen Inputs oder in einem Anhang bei, oder es wird darauf verwiesen. Es kann natürlich vorkommen, dass Sie sich zur Lösung der Aufgabe noch Wissen aneignen müssen.

Was wenn mir die gegebenen Anforderungen zur Lösung nicht ausreichen?

Wie im richtigen Leben kann es sein, dass Ihnen zur Lösung der Aufgabe Informationen fehlen. Im Einzelfall scheinen sich Anforderungen sogar zu widersprechen (beispielsweise Aussagen in Interviews von Stakeholdern mit unterschiedlichen Prioritäten). Normalerweise klären sie das im Projekt mit den Beteiligten, finden Kompromisse, etc. Da Ihnen die Leute im Rahmen Ihrer Hausaufgabe nicht zur Verfügung stehen, treffen Sie Annahmen. Diese kennzeichnen Sie in Ihrer Lösung explizit als solche. Achten Sie darauf, dass diese sinnvoll und konsistent untereinander und zur Aufgabenstellung sind.

Weitere Informationen

Ich hoffe, ich konnte einen Eindruck vermitteln, wie die Prüfungsaufgaben im CPSA-Advanced-Level grundsätzlich aussehen. Wenn Sie Fragen zu dem Thema haben, kommen Sie gerne auf mich zu. Ansonsten: Auf der iSAQB-Seite finden Sie vieles rund um den Advanced-Level. Hier noch ein paar weiterführende Links …

softwarearchitektur-meetup-hamburg

Softwarearchitektur Meetup: Architekturarbeit in Hamburg

By | Allgemein | No Comments

Am 26. April wird im Hamburger Softwarearchitektur Meetup der Blick auf die Arbeitsweise von Architekten gerichtet.

Meetup
 Architekturarbeit in Hamburg
Referent: Jan Gentsch
Organisation: Harm Gnoyke
Veranstaltung beim Softwarearchitektur Meetup Hamburg
26. April 2016, 18:30 Uhr
HAW Hamburg, Raum 1281 im Berliner Tor 7

Zur kostenlosen Anmeldung

Architekturarbeit ist den letzten Jahren nicht einfacher geworden. Neue Technologien und Trends entwickeln sich oft rasant und wollen verstanden und bewältigt werden. Agile Entwicklungsmethoden haben den Mainstream erreicht und verändern etablierte Vorgehensweisen und Formen der Zusammenarbeit.

Uns interessiert: Wo steht Architekturarbeit heute?

Wo funktioniert sie gut? Was ist immer noch schwierig? Welchen Einfluss hat das Umfeld? Was bewährt sich? Was ist nur heiße Luft?

Um Antworten auf diese Fragen zu finden, werden vor dem Meetup dazu Stories zur Architekturarbeit gesammelt und dann im Meetup gemeinsam ausgewertet.

Dazu bitten wir Euch, um Eure eigenen Erlebnisse (= „Stories“) zur Architekturarbeit und um eine kurze strukturierte Einschätzung zu jeder Story. Die Stories erfassen wir mit einer eigens entwickelten App. Der Link dazu ist hier (dauert keine 15 Minuten!):

Zur Umfrage

Mit Hilfe dieser Methode bekommen wir nicht nur reine Statistik, sondern hoffentlich auch die greifbare Geschichte davon erzählt, wie ihr Architekturarbeit heute lebt.

Ihr dürft gerne mehrere Geschichten einreichen! Grundlegendes zur Umfrage: Die Teilnahme an der Umfrage ist anonym. Teilt nur Informationen, mit denen Ihr euch selber wohl fühlt und nennt bitte Beteiligte oder Unternehmen nicht namentlich.

Im Meetup selbst werden die Ergebnisse nach einem Überblick über die Umfrage dann gemeinsam analysiert und diskutiert. Wir sind schon gespannt auf die Erkenntnisse!