Diagramme der Moderne

Transkript

1 Diagramme der Moderne Softwarearchitektur zeitgemäß visualisieren. STEFAN ZÖRNER, EMBARC Softwarearchitektur Meetup Hamburg, Softwarearchitektur zeitgemäß visualisieren. Die Kommunikation zentraler Architekturideen im Team und gegenüber anderen ist heute wichtiger denn je. Visualisierungen können dabei unterstützen, tun es aber nicht automatisch. An diesem Abend vermittelt Stefan Zörner (embarc) Erfolgsfaktoren, um mit angemessenem Aufwand wirkungsvolle Abbildungen Eurer Softwarearchitektur zu erstellen und zu pflegen. Zur Sprache kommen Notationsoptionen, empfohlene Werkzeuge und Vorgehen. Das Gelernte übt Ihr direkt in kleinen, fokussierten Übungen. 2 1

2 Stefan Zörner n Softwareentwickler + -architekt bei embarc in Hamburg n Vorher oose, IBM, Mummert + Partner, Bayer AG, Schwerpunkte: n Softwarearchitektur (Entwurf, Bewertung, Dokumentation) n Java Technologien xing.to/szr 3 Agenda 1 Einstieg 2 Tipps und Tricks für Diagramme 3 Überblick Diagrammarten 4 Wie geht Ihr vor? 1 5 Fazit, Diskussion, Ausblick 4 2

3 Zitat Wir benutzen für unsere Architekturdiagramme UML. Ist standardisiert. Kann jeder lesen -- der unbekannte Softwarearchitekt 5 Diagramme Bestimmte Sachverhalte lassen sich mit Bildern besser kommunizieren als mit Text allein. Strukturen Elemente, deren Beziehungen untereinander Teil / Ganzes Verwendung / Nutzung Konkretisierung / Generalisierung Abläufe Verhalten im System, Daten- / Kontrollfluss Schritte Alternativen, Wiederholungen Nebenläufigkeit / Parallelität 6 3

4 Das muss nicht immer klappen ;-) 7 Nassi-Shneiderman-Diagramm ab

5 Entity-Relationship-Diagramm ab Unified Modelling Language ab 1997 als Standard 14 Diagrammarten, 978 Seiten Spezifikation 10 5

6 Beispiel: Amazon Web Services 2017? 11 Projektwirklichkeit Viele Teams und Projekte fertigen gar keine Diagramme an. Gründe: keine Zeit finden keinen Bedarf sehen Unsicherheit 12 6

7 Agenda 1 Einstieg 2 Tipps und Tricks für Diagramme 3 Überblick Diagrammarten 4 Wie geht Ihr vor? 2 5 Ausblick 13 Agenda 1 Einstieg 2 Tipps und Tricks für Diagramme 3 Überblick Diagrammarten 4 Wie geht Ihr vor? 2 5 Fazit, Diskussion, Ausblick 14 7

8 Disclaimer Die folgenden Prinzipien dürft Ihr im Einzelfall brechen. Unter Umständen müsst Ihr das sogar (z.b. wegen Werkzeugeigenheiten). Mitunter haben die Dinge mit persönlichem Geschmack zu tun. Ziel: Ansprechende Diagramme, die sich dem Betrachter leicht erschließen. 15 Gestaltgesetze Als Gestaltpsychologie wird eine Richtung innerhalb der Psychologie bezeichnet, die die menschliche Wahrnehmung als Fähigkeit beschreibt, Strukturen und Ordnungsprinzipien in Sinneseindrücken auszumachen. Wikipedia Gestaltgesetze (Auswahl) Gesetz der Nähe Gesetz der Ähnlichkeit Gesetz der guten Fortsetzung (oder der durchgehenden Linie) Gesetz der gemeinsamen Region

9 Beispiel in der Technik Gesetz der Nähe Gesetz der Ähnlichkeit Gesetz der gemeinsamen Region Auffälligkeit der Elemente Verschiedenheit erregt Aufsehen. Gleich wichtige Dinge sollten z.b. gleich groß sein. 18 9

10 Leserichtung für Diagramme Standard-Leserichtung für Diagramme: links nach rechts, bzw. oben nach unten. 19 Kreuzungspunkte bei Linien Vermeidet wo immer möglich, dass Verbindungslinien sich schneiden

11 Kreuzungspunkte bei Linien Falls sich Schneiden nicht vermeiden lässt, besser: überbrücken / unterbrechen. 21 Kontaktpunkte bei Linien (1) Linien schlagen nicht an Ecken und nicht gemeinsam auf Komponenten auf

12 Kontaktpunkte bei Linien (2) Linien werden nicht vor dem Kontakt zu einem Element zusammengeführt. 23 Legende 24 12

13 Legende 25 Legende 26 13

14 Simplified Chinese 27 Simplified Chinese Simplified UML 28 14

15 Simplified UML Verwende nur wenige unterschiedliche Modellelemente in Deinen UML- Diagrammen, die aber korrekt. 29 Agenda 1 Einstieg 2 Tipps und Tricks für Diagramme 3 Überblick Diagrammarten 4 Wie geht Ihr vor? 3 5 Fazit, Diskussion, Ausblick 30 15

16 Klassisch: Sichten ( Views ) IEEE 1471 is a superseded IEEE Standard for describing the architecture of a "software-intensive system", also known as software architecture. In 2011 it was superseded by ISO/IEC/IEEE 42010:2011, Systems and software engineering Architecture description. Wikipedia 31 Begriffswelt der IEEE

17 Eine Implementierung : arc42 Vorschlag für ein Template (G. Starke, P. Hruschka) è 33 Eine Implementierung : arc

18 Sichten in arc42 Kontextabgrenzung (System Context) Zeigt die beteiligten Fremdsysteme und Benutzer, mit denen das zu beschreibende System interagiert. Bausteinsicht (Building Block View) Zeigt die Struktur des Softwaresystems in Form seiner Bausteine, und wie diese zusammenhängen. Bündelt viele Entscheidungen rund um Verantwortlichkeiten. Laufzeitsicht (Runtime View) Zeigt Elemente der Baustein- und/oder Kontextsicht in Aktion, veranschaulicht dynamische Strukturen und Verhalten des beschriebenen Systems. Verteilungssicht (Deployment View) Zeigt wie die Software in Betrieb genommen (verteilt) wird, und wie die Zielumgebung aussieht. 35 Zitat Der Quelltext ist die Dokumentation. -- der unbekannte (agile?) Entwickler 36 18

19 Replik Der Quelltext erzählt nicht die ganze Geschichte. -- Simon Brown 37 Ein anderer Blick: Simon Brown Simon Brown: Software Architecture for Developers Technical leadership by coding, coaching, collaboration, architecture sketching and just enough up front design è

20 Ein anderer Blick: Simon Brown Simon Brown: Software Architecture for Developers, Volume 2 Visualize, document and explore your software architecture è 39 Simon Brown: C4 Model Agree on a simple set of abstractions that the whole team can use to communicate. Draw a number of simple diagrams at different levels of abstraction. C4: context, containers, components, classes (code) è

21 Lösungsstrategie (Tabelle) Architekturziele und zugeordnete high-level Lösungsansätze, mit Verweisen auf Überblicksbild und Lösungsdetails Form: Tabelle ([ Ziele Lösungsansätze ]). Architektur-/ Lösungsansätze Architektur-/ Qualitätsziele 41 Typische Lösungsansätze 42 21

22 Überblicksbild erstellen 43 Beispiel

23 Agenda 1 Einstieg 2 Tipps und Tricks für Diagramme 3 Überblick Diagrammarten 4 Wie geht Ihr vor? 4 5 Fazit, Diskussion, Ausblick 45 Schritt für Schritt zum Überblick Zielgruppen und Ziele identifizieren 2. Zutaten auswählen und anfertigen 3. Zutaten in Form bringen 4. Architekturüberblick auf Gebrauchstauglichkeit überprüfen 46 23

24 Schritt für Schritt zum Überblick Zielgruppen und 1 Ziele identifizieren Zutaten auswählen Zum Beispiel Neue im Team, 2 und anfertigen Entscheider, teamfremde Kollegen... Passend zu den Zielgruppen und deren Zielen Schritte wiederholen, bei Bedarf verfeinern, neue Zielgruppen, Formen, Zutaten ergänzen. In der Kreuztabelle festhalten, welche Zutat primär für welche Zielgruppen ist. Schreiben Sie aus Sicht der Leser. 4 Architekturüberblick auf Gebrauchstauglichkeit überprüfen Review durch Zielgruppe, Feedback einfließen lassen... Statt eines bloßen X können Sie in den Zellen der Kreuz- tabelle auch Dringlichkeit und/ oder nötige Tiefe (detailliert, Überblick...) eintragen. Zutaten in Form 3 bringen Mit Hilfe der Zielgruppen geeignete Formen wählen und Zutaten darin zu Überblicken kombinieren 47 Schritt für Schritt zum Überblick Zielgruppen und 1 Ziele identifizieren Zutaten auswählen Zum Beispiel Neue im Team, 2 und anfertigen Entscheider, teamfremde Kollegen... Passend zu den Zielgruppen und deren Zielen 48 24

25 Was gehört hinein? Problemstellung Lösungsstrategie Lösungsdetails Mission Statement Einflussfaktoren Architekturziele Randbedingungen Risiken Lösungsstrategie Architekturprinzipien Architekturentscheidungen Sichten Struktur Verhalten Verteilung Kontextabgrenzung Überblicksbild Übergreifendes Konzept 49 Schritt für Schritt zum Überblick Zielgruppen und Ziele identifizieren 2. Zutaten auswählen und anfertigen 3. Zutaten in Form bringen 4. Architekturüberblick auf Gebrauchstauglichkeit überprüfen 50 25

26 Schritt für Schritt zum Überblick Zielgruppen und 1 Ziele identifizieren Zutaten auswählen Zum Beispiel Neue im Team, 2 und anfertigen Entscheider, teamfremde Kollegen... Passend zu den Zielgruppen und deren Zielen In der Kreuztabelle festhalten, welche Zutat primär für welche Zielgruppen ist. Schreiben Sie aus Sicht der Leser. Statt eines bloßen X können Sie in den Zellen der Kreuztabelle auch Dringlichkeit und/ oder nötige Tiefe (detailliert, Überblick...) eintragen. Zutaten in Form 3 bringen Mit Hilfe der Zielgruppen geeignete Formen wählen und Zutaten darin zu Überblicken kombinieren 51 Struktur für Folienvortrag Abschnitt Mögliche Inhalte I. Aufgabenstellung Mission Statement Architekturziele Kontextabgrenzung Herausforderungen, Schmerzpunkte Zentrale Randbedingungen II. The Big Picture III. Die Lösung im Detail IV. Fazit und Ausblick Lösungsstrategie (Tabelle) Informelles Überblicksbild Architekturprinzipien Architekturentscheidungen Diagramme (Struktur, Verteilung,...) Übergreifende Konzepte Demo, Walkthrough Offene Punkte Nächste Schritte Diskussion Weitere Informationen Was sind Ihre Fragen? 52 26

27 Struktur für Folienvortrag Abschnitt Mögliche Inhalte I. Aufgabenstellung Mission Statement Architekturziele Kontextabgrenzung Herausforderungen, Schmerzpunkte Zentrale Randbedingungen II. The Big Picture III. Die Lösung im Detail IV. Fazit und Ausblick Lösungsstrategie (Tabelle) Informelles Überblicksbild Architekturprinzipien Architekturentscheidungen Diagramme (Struktur, Verteilung,...) Übergreifende Konzepte Demo, Walkthrough Offene Punkte Nächste Schritte Diskussion Weitere Informationen Was sind Ihre Fragen? (Fett gedruckte Inhalte sind besonders wichtig.) 53 Struktur für Folienvortrag Abschnitt Mögliche Inhalte I. Aufgabenstellung Mission Statement Architekturziele Kontextabgrenzung Herausforderungen, Schmerzpunkte Zentrale Randbedingungen II. The Big Picture III. Die Lösung im Detail IV. Fazit und Ausblick Lösungsstrategie (Tabelle) Informelles Überblicksbild Architekturprinzipien Architekturentscheidungen Diagramme (Struktur, Verteilung,...) Übergreifende Konzepte Demo, Walkthrough Offene Punkte Nächste Schritte Diskussion Weitere Informationen Was sind Ihre Fragen? (Fett gedruckte Inhalte sind besonders wichtig.) (Rot: Diagramme als Inhalte) 54 27

28 Architekturwand Quelle: S. Toth, Vorgehensmuster für Softwarearchitektur 55 Formen: Stärken und Schwächen positiv negativ neutral Dokument Foliensatz Wiki Architekturwand Poster/Flyer Initialer Aufwand niedrig, bei Start mit wenigen Zutaten und guter Struktur niedrig, bei Start mit wenigen Folien und guter Struktur mittel, ggf. Auswahl/ Einrichtung eines Produktes nötig mittel, geeignete freie Wand und passende Kultur nötig Anspruch an erste Auflage oft bereits sehr hoch Ändern und erweitern im nachhinein leicht zu ändern und um Zutaten zu ergänzen, bei passendem Tooling leicht zu ändern und zu ergänzen, Versionierung ggf. schwierig leicht, Versionen und Verfolgen von Änderungen aber je nach Produkt jederzeit möglich, aber Änderungen nachhalten schwierig schwierig, da Platz begrenzt und Produktion aufwändig Akzeptanz bei Entwicklern gering, OK zum Lesen, falls prägnant und zielgruppengerecht allein nur mittel, in Präsentationen / bei Durchsprachen höher eher hoch, gleichzeitig Vorurteile wegen häufiger Verrottung hoch, da die Wand zu Feedback und Mitarbeit einlädt hoch, falls gut gemacht. Spannendes, ungewohntes Format Akzeptanz bei Managern hoch, entspricht oft der Erwartung allein nur mittel, um Präsentationen zu unterstützen höher gering, etwas besser bei zielgruppengerechten Einstiegsseiten mittel, wird eher als Arbeitsmittel der Entwicklung gesehen hoch, falls grafisch ansprechend und klar gestaltet Kommunikation in räumlich verteilten Teams Verteilung zwar einfach, aber fördert für sich allein nicht den Austausch mittel. Folien allein oft nicht aussagekräftig, zusätzliche Präsentationen aufwändig für Kollaboration in verteilten Teams vergleichsweise gut geeignet schlecht, ggf. ist eine Verbreitung über Fotos möglich sind gut an Lokationen zu verteilen, Flyer ebenso, Feedback schwierig 56 28

29 Schritt für Schritt zum Überblick Zielgruppen und Ziele identifizieren 2. Zutaten auswählen und anfertigen 3. Zutaten in Form bringen 4. Architekturüberblick auf Gebrauchstauglichkeit überprüfen 57 Gebrauchstauglichkeit 7 Regeln für gute Dokumentation 1. Schreibe aus Sicht des Lesers 2. Vermeide unnötige Wiederholungen 3. Vermeide Mehrdeutigkeiten 3. a) Erkläre Deine Notation 4. Verwende eine Standardstrukturierung 5. Halte Begründungen für Entscheidungen fest 6. Halte Dokumentation aktuell, aber auch nicht zu aktuell Documenting Software Architectures: Views and Beyond Clements, et.al, 2. Auflage Überprüfe Dokumentation auf ihre 58 29

30 Gebrauchstauglichkeit 7 Regeln für gute Dokumentation Documenting Software Architectures: Views and Beyond Clements, et.al, 2. Auflage Schreibe aus Sicht des Lesers 2. Vermeide unnötige Wiederholungen 3. Vermeide Mehrdeutigkeiten 3. a) Erkläre Deine Notation 4. Verwende eine Standardstrukturierung 5. Halte Begründungen für Entscheidungen fest 6. Halte Dokumentation aktuell, aber auch nicht zu aktuell 7. Überprüfe Dokumentation auf ihre 59 Schritt für Schritt zum Überblick Zielgruppen und 1 Ziele identifizieren Zutaten auswählen Zum Beispiel Neue im Team, 2 und anfertigen Entscheider, teamfremde Kollegen... Passend zu den Zielgruppen und deren Zielen Schritte wiederholen, bei Bedarf verfeinern, neue Zielgruppen, Formen, Zutaten ergänzen. In der Kreuztabelle festhalten, welche Zutat primär für welche Zielgruppen ist. Schreiben Sie aus Sicht der Leser. 4 Architekturüberblick auf Gebrauchstauglichkeit überprüfen Review durch Zielgruppe, Feedback einfließen lassen... Statt eines bloßen X können Sie in den Zellen der Kreuztabelle auch Dringlichkeit und/ oder nötige Tiefe (detailliert, Überblick...) eintragen. Zutaten in Form 3 bringen Mit Hilfe der Zielgruppen geeignete Formen wählen und Zutaten darin zu Überblicken kombinieren 60 30

31 Was mindestens zu Beginn? Quelle: S. Toth, Vorgehensmuster für Softwarearchitektur 61 Agenda 1 Einstieg 2 Tipps und Tricks für Diagramme 3 Überblick Diagrammarten 4 Wie geht Ihr vor? 5 5 Fazit, Diskussion, Ausblick 62 31

32 Wie macht Ihr es richtig? Zwei persönliche Ratschläge von mir rund um Diagramme: 1 Schreibt zu jedem Diagramm einen Satz, der beschreibt was zu sehen ist ( Mission Statement, Kernaussage). 2 Lasst Euch nicht von der Notation behindern. Benutzt wenige Elemente. Erklärt diese in einer Legende! Buch: Richtlinien und Best Practices für UML 2.0-Diagramme The Elements of UML 2.0 Style Autor: Scott W. Ambler Umfang: ca. 200 Seiten Verlag: Cambridge University Press 2005 Sprache: Englisch ISBN:

33 Buch: Softwarearchitekturen dokumentieren und kommunizieren Entwürfe, Entscheidungen und Lösungen nachvollziehbar und wirkungsvoll festhalten Autor: Stefan Zörner Umfang: ca. 280 Seiten Verlag: Hanser Verlag, 2. Aufl., Mai 2015 Sprache: Deutsch ISBN: Book: arc42 by example Real software architectures, documented with the arc42 template. Helps you jumpstart your own documentation. Authors: Gernot Starke Michael Simons Stefan Zörner Language: English MOBI, EPUB, PDF è

34 Spicken erlaubt! Unsere Architektur-Spicker beleuchten die konzeptionelle Seite der Softwareentwicklung. Bisher erschienen: #1 Der Architekturüberblick #2 Quantitative Analyse #3 Microservices #4 Architektur-Reviews #5 Cloud-Anwendungen PDF, 4-6 Seiten Kostenloser Download. è 67 Spicken erlaubt! ç Unsere Architektur-Spicker beleuchten die konzeptionelle Seite der Softwareentwicklung. Spicker #1: Der Architekturüberblick Welche Zutaten gehören in einen Architekturüberblick? Welche Formen bewähren sich in welchen Situationen? Wie fertigen Sie einen Architekturüberblick an? PDF, 4 Seiten Kostenloser Download. è

35 Vielen Dank. Ich freue mich auf Eure xing.to/szr Bei uns arbeiten? Bereit zum Durchstarten? Da haben wir was... Berater/in gesucht! für Softwarearchitektur / Agilität / CD & DevOps / Microservices (Standort flexibel in Deutschland oder Wien) Du brennst für ein Thema und bist motiviert, Dich mit aktuellen Trends tiefer auseinander zu setzen? Du hast eher zu viele Ideen als zu wenige? Du teilst Deine Erkenntnisse und Erfahrungen gerne mit Kollegen und denkst Themen weiter? Du stehst auf Pragmatismus, nicht auf Mikro-Management? Wir glauben weniger an ausgefeilte interne Strategien, als an die Möglichkeiten die entstehen wenn sich leidenschaftliche Leute zusammenschließen. Klingt interessant? Sprich uns gerne direkt an oder Mail an Tabea.Hentschel@ /karriere 70 35