Phantastische Diagramme und wie Du sie selbst erstellst

by Ralf D. Müller

Slide 1

Slide 1 text

Phantastische Diagramme …und wie Du sie selbst erstellst Falk Sippach embarc Ralf D. Müller DB Systel GmbH

Slide 2

Slide 2 text

Phantastische Diagramme …und wie Du sie selbst erstellst Zusammenfassung Die wichtigste Aufgabe eines Software-Architekten besteht darin, die Architektur zu kommunizieren. Neben den textuellen Inhalten gilt es auch, Grafiken zu erstellen. Getreu dem Motto "ein Bild sagt mehr als tausend Worte" helfen Diagramme bei einer effektiven und pragmatischen Dokumentation. Damit sie wirken, müssen sie leicht erfassbar, stets aktuell und korrekt sein.. In diesem Talk spüren wir zuerst die Schwachstellen vieler Diagramme auf und überlegen uns anschließend, wie wir sie umgehen können. Das Ergebnis ist eine Checkliste für richtig gute, fast schon phantastische Architektur-Diagramme. Als Bonus werden wir aufzeigen, wie Diagramme wartbar mit dem Docs-as-Code Ansatz umgesetzt werden, um sie jederzeit aktuell und im Einklang mit der Architektur halten zu können. 3 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 3

Slide 3 text

[email protected] @sippsack ➔ xing.to/fsi Falk Sippach ◼ Softwarearchitekt, Berater, Trainer bei embarc ◼ früher bei Orientation in Objects (OIO), Trivadis 5 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 4

Slide 4 text

[email protected] @ralfdmueller ➔ xing.to/rdmuller Ralf D. Müller ◼ was mit Dokumentation, Security und Architektur by der DB Systel ◼ Maintainer von docToolchain, Contributor arc42 ◼ co-Autor 6 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 5

Slide 5 text

JavaLand 2023 Wer seid Ihr? 7 https://forms.gle/Ejsgzp1BFoBrB9Hs6 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 6

Slide 6 text

Mission Statement ■ Schwachstellen vieler Diagramme aufzeigen. ■ Checkliste für richtig gute Architekturdiagramme diskutieren. ■ Für Architekturdokumentation relevante Diagrammarten vorstellen. ■ Diagramme wartbar mit Docs-as-Code Ansatz umsetzen. ■ Leichtgewichtige Werkzeuge zur Diagrammerstellung zeigen. 8 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 7

Slide 7 text

Dokumentation? 9 aus: Effektive Softwarearchitekturen (G. Starke) Architektur bewerten Architektur kommunizieren Architektur entwerfen Anforderungen klären Architektur kommunizieren Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 8

Slide 8 text

Gute Gründe … 10 Entwurfsunterstützung Kommunikation Neue Mitarbeiter Frage nach dem Warum Bewertbarkeit Grafik von The Practical Dev (CC0 Public Domain Lizenz) Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 9

Slide 9 text

Ungeeignete Werkzeuge Medienbruch Dateiablage Redundanzen Textwüsten Handarbeit Veraltet Liest sowieso keiner! Liest sowieso keiner! Ungeeignete Werkzeuge Redundanzen Textwüsten 11 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc Helfen uns hier Diagramme?

Slide 10

Slide 10 text

Ein Bild sagt mehr als 1000 Worte … 12 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 11

Slide 11 text

Agenda Werkzeuge Gute Diagramme 13 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc Einbettung in Dokumentation

Slide 12

Slide 12 text

Agenda Werkzeuge Gute Diagramme 14 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc Einbettung in Dokumentation

Slide 13

Slide 13 text

Einleitung Qualitätskriterien ? 15 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 14

Slide 14 text

Tipp 1: Qualitätskriterien für Diagramme Ein Diagramm dient der Kommunikation Darum muss es lesbar und verständlich sein Es muss die gewünschte Information transportieren Denke an einen Rückkanal, sonst handelt es sich um einseitige Kommunikation Denke an die Wart- und Modifizierbarkeit . 16 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 15

Slide 15 text

„All Models are Wrong but some are Useful“ George Box 17 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 16

Slide 16 text

Was ist ein Modell? Bild von Hans Benn auf Pixabay 18 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 17

Slide 17 text

Was ist ein Modell? Bild von Hans Benn auf Pixabay https://www.wolfsburgwest.com/cart/DetailsList.cfm?ID=211971013B 19 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 18

Slide 18 text

Tipp 2: Zweck des Diagramms beachten Ein Diagramm / eine View erfüllt einen einzigen Zweck Widerstehe der Versuchung zu viele Arten von Informationen in einem Diagramm unterzubringen Ja, betrachtet man das Diagramm aus der falschen Sicht, wird es falsch sein darum beschrifte das Diagramm, um den Zweck klarzustellen . 20 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 19

Slide 19 text

Visual Style 21 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 20

Slide 20 text

Ein Beispiel 22 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 21

Slide 21 text

Farben 23 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 22

Slide 22 text

A B C D E H Task Handler HW Buffer F G delegiert tauscht aus ruft auf ruft auf So nicht… 24 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 23

Slide 23 text

Größe 25 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 24

Slide 24 text

Pfeilrichtung 26 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 25

Slide 25 text

Linienstärke 27 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 26

Slide 26 text

Text-Stile 28 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 27

Slide 27 text

Beschriftung 29 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 28

Slide 28 text

Abstraktionslevel 30 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 29

Slide 29 text

Legende 31 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 30

Slide 30 text

Landscape 32 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 31

Slide 31 text

Tipp 3: Visuelle Stile Farben sparsam und entsprechend ihrer natürlichen Bedeutung einsetzen Decorator oder Formen zur Unterscheidung der Elemente einsetzen Schriftgrößen und Stile bewusst einsetzen Verbindungen und Elemente beschriften Unterschiedliche Größen bewusst einsetzen Verbindungen nicht überlappen und nur in eine Richtung 34 A A Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 32

Slide 32 text

c4model.com 35 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 33

Slide 33 text

c4model.com: Context 36 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 34

Slide 34 text

c4model.com: Containers 37 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 35

Slide 35 text

c4model.com: Components 38 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 36

Slide 36 text

c4model.com: Classes Quelle der C4-Diagramme c4model.com 39 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 37

Slide 37 text

c4model.com Quelle der C4-Diagramme c4model.com 40 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 38

Slide 38 text

Agenda Werkzeuge Gute Diagramme 41 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc Einbettung in Dokumentation

Slide 39

Slide 39 text

PlantUML 42 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 40

Slide 40 text

Diagramme: PlantUML 43 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 41

Slide 41 text

Diagramme: PlantUML 44 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 42

Slide 42 text

Diagrams.net 45 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 43

Slide 43 text

Diagrams.net PNG-Diagramm … Meta-Daten 46 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 44

Slide 44 text

https://kroki.io/ 47 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 45

Slide 45 text

https://vega.github.io/vega/ 48 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 46

Slide 46 text

Diagramme: Nicht malen, modellieren! 49 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 47

Slide 47 text

{adoc:stakeholder} | Operations | Betreiber und Administratoren von VENOM | Flexibilität hinsichtlich Betriebsumgebung, Betriebssystem. Möglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen. Technisches Monitoring. treat Docs-as-Code: automate! 50 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 48

Slide 48 text

Slide 49

Slide 49 text

52 treat Docs-as-Code: automate! Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 50

Slide 50 text

Agenda Werkzeuge Gute Diagramme 53 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc Einbettung in Dokumentation

Slide 51

Slide 51 text

Analogie Bauwesen 54 Ansicht Schnitt Grundriss Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 52

Slide 52 text

Sichten in arc42 ➔https://arc42.de/ Dr. Peter Hruschka http://www.peterhruschka.eu/ Dr. Gernot Starke http://gernotstarke.de/ 55 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 53

Slide 53 text

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. 56 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 54

Slide 54 text

Ursprung: 4+1 Sichten Das 4+1-Sichten-Softwarearchitekturmodell ist ein weit verbreitetes Modell der Sichten auf ein Softwaresystem, das von Philippe Kruchten zur „Beschreibung der Architektur eines Software-intensiven Systems auf der Grundlage von mehreren konkurrierenden Sichten“ entwickelt wurde. Philippe Kruchten https://de.wikipedia.org/wiki/4%2B1_Sichtenmodell 57 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 55

Slide 55 text

Elemente des 4+1 Verteilungssichten Entwicklungssichten Bausteinsichten Laufzeitsichten Anwendungs- fälle, Prozesse 58 https://de.wikipedia.org/wiki/4%2B1_Sichtenmodell#/media/Datei:4+1_Architectural_View_Model.jpg Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 56

Slide 56 text

To UML or to not UML? “Wir benutzen für unsere Architekturdiagramme UML. Ist standardisiert. Kann jeder lesen.” -- unbekannte Softwarearchitekt:in 59 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 57

Slide 57 text

Bausteinsichten Mögliche UML-Diagrammarten Verteilungssichten Laufzeitsichten Anwendungs- fälle, Prozesse 60 Klassendiagramm Kommunikations- diagramm Sequenzdiagramm Komponenten- diagramm Paketdiagramm Verteilungs- diagramm Sequenzdiagramm Aktivitätsdiagramm Anwendungsfall- diagramm Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc Entwicklungssichten

Slide 58

Slide 58 text

Kontextabgrenzung Dieser fachliche Systemkontext zeigt das Corona-Warn-App-System im Zusammenspiel mit den wichtigsten Benutzern und Fremdsystemen. 61 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 59

Slide 59 text

Tatsächliche Zerlegung im Quelltext GitHub-Repositories https://github.com/corona-warn-app/... ■ cwa-app-android ■ cwa-app-ios ■ cwa-server („Backend“) ■ cwa-testresult-server ■ cwa-verification-server ■ cwa-verification-portal „Bausteinsicht, Ebene 1“ CWA-Server (Backend), Bausteinsicht, Ebene 2 62 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 60

Slide 60 text

Beispiel eines Ablaufes 63 https://www.dokchess.de/ Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 61

Slide 61 text

Beispiel eines Ablaufes 64 https://www.dokchess.de/ Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 62

Slide 62 text

Sequenzdiagramm mit PlantUML 65 @startuml actor browser as "User/Browser" participant html5 as "HTML5-Client" participant Keycloak participant socialprovider as "Social Provider" participant server as "Rest-Server" browser -> html5 : Request (not authenticated) browser <-- html5 : Redirect to Keycloak browser -> Keycloak : Request (not authenticated) browser <-- Keycloak : Login page browser -> Keycloak : Choose social login browser <-- Keycloak : Redirect to social login page browser -> socialprovider : Login browser <-- socialprovider : Redirect to client browser -> Keycloak : Social authenticate browser <-- Keycloak : Redirect to client (with access and id token) html5 -> server : JavaScript call to REST backend (with Bearer-Token) html5 <-- server browser <-- html5 : Response @enduml Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 63

Slide 63 text

Verteilungssicht "immer-nur-schach" 66 aus: "Software-Architekturen dokumentieren und kommunizieren" von Stefan Zörner Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 64

Slide 64 text

Waren das schon alle Sichten? 67 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 65

Slide 65 text

Informelles Überblicksbild Quelle der Abbildung: S. Zörner, F. Sippach: „So gehen Architektur-Reviews! Entlang der Corona-Warn-App“, OOP 2021 68 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 66

Slide 66 text

Alternative: C4 Model (Simon Brown) ▪ 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) ➔ http://static.codingthearchitecture.com/c4.pdf 69 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 67

Slide 67 text

Alternative C4: Inhalte 70 Level 1: System Context Level 2: Container Diagram Level 3: Component Diagram Level 4: Code Deployment Diagram Dynamic Diagram Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 68

Slide 68 text

Entwicklungssichten Bausteinsichten Alle Sichten auf einen Blick 71 Laufzeitsichten Verteilungssichten Informelles Überblicksbild Anwendungsfälle/ Prozesse Kontextsichten 4 + 1 (Kruchten) Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 69

Slide 69 text

Entwicklungssichten Bausteinsichten Diagramm-Tools - Empfehlungen 72 Laufzeitsichten Verteilungssichten Informelles Überblicksbild Anwendungsfälle/ Prozesse Kontextsichten draw.io/diagrams.net PlantUML (Anwendungsfall- diagramm) PlantUML (Sequenzdiagramm, Aktivitätsdiagramme) PlantUML (Sequenzdiagramm, Aktivitätsdiagramme) draw.io/diagrams.net draw.io/diagrams.net PlantUML (Komponenten- diagramm) draw.io/diagrams.net Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 70

Slide 70 text

Beispiele Umsetzung in diagrams.net 73 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 71

Slide 71 text

Documentation-as-Code Ablage im Repo Versionier- /Diffbar Synchrone Auslieferung Offlinefähig Teil des Build- Prozesses Generierung/ Automatisierung Flexible Ausgabe Nähe zum Sourcecode

Slide 72

Slide 72 text

Continuous Documentation Automatisiert erstellen Regelmässig ausliefern Stetig ergänzen Reviewen Feedback integrieren

Slide 73

Slide 73 text

0 1 2 3 4 5 6 Herkömmliche Dokumentation Leichtgewichtige Textformate, Ablage im Code-Repo Standardstrukturierungen verwenden Grafiken als Text Tool-Integration und Inhalte generieren Feedback und kontinuierliche Verbesserung Ausführbare Dokumentation Docs–as-Code Reifegradmodell (Maturity Level) Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc 76

Slide 74

Slide 74 text

Werkzeuge IDEs, Texteditoren Build-Management Grafiken Textformate, Standards + Plug-ins

Slide 75

Slide 75 text

asciidoctor your solution architecture documentation pdf plugin diagram plugin plantUML read PDF generate PDF HTML5 generate HTML arc42 asciidoc template is derived from Basic Docs-as-Code with AsciiDoc 78 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 76

Slide 76 text

Basic Docs-as-Code with AsciiDoc & docToolchain 79

Slide 77

Slide 77 text

Docs-as-Code in der IDE – eine besondere Liebe ❤️🥰 Syntax-Highlighting, … Autovervollständigung, Modularisierung, … Diagrams-as-Code mit PlantUML, Vorschau, … Draw.io inside …

Slide 78

Slide 78 text

Ausblick Werkzeuge Gute Diagramme 81 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc Einbettung in Dokumentation

Slide 79

Slide 79 text

Checkliste für Architekturdiagramme 82 Gibt es eine Überschrift und eine Legende? Autor, Erstellungs- und Änderungsdatum vorhanden? Per URL verlinkbar statt Copy-by-Value? Ist die Quelle bekannt und ist es leicht editierbar? Wurde ein passendes Werkzeug verwendet? Ist der Diagrammtyp klar erkennbar und wurde der passende Typ gewählt? Diagrammzweck ersichtlich? Ist jedes Element benannt, die Bedeutung ersichtlich und die Funktion verständlich? Sind die verwendeten Abkürzungen ersichtlich? Bedeutung aller Farben und Formen ersichtlich? Bedeutung unterschiedlicher Größe und aller Rahmenstile verständlich? Sind alle Verbindungen beschriftet und die Bedeutung der Linien klar? Ist die Bedeutung der Pfeilspitzen und Linienstile (fett, gestrichelt, …) ersichtlich? Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 80

Slide 80 text

Vorteile Diagrams-as-Code (und leichtgewichtige Diagramme) 83 Jederzeit und von jedem editierbar. Leicht zu erstellen. Entwicklertools verwendbar. Automatisches Layouting und Rendering. Direkte Unterstützung der Notation. Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc Versionier- und historisierbar. Leicht zu aktualisieren einheitlicher Stil

Slide 81

Slide 81 text

Sehen wir uns am Stand? 12:45 Uhr im Ausstellungsbereich, Stand 412 84 Stand 412 in der Community Hall Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 82

Slide 82 text

Training zu Docs-as-Code ➔ https://www.socreatory.com/en/trainings/docascode Softwarearchitekturdokumentation praktisch mit Entwicklerwerkzeugen umsetzen 85 Wir kommen auch zu Euch in die Firma! Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 83

Slide 83 text

Weiterführende Blog-Posts ➔ https://www.embarc.de/was-ist-docs-as-code/ ➔ https://www.embarc.de/doctoolchain/ Was ist eigentlich Docs-as-Code? & Eine Einführung in docToolchain 86 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 84

Slide 84 text

Weiterführende Videos/Podcasts ➔ https://software-architektur.tv/2022/10/14/folge138.html/ ➔ https://software-architektur.tv/2022/12/16/folge146.html/ 87 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 85

Slide 85 text

Einführung in Docs-as-Code https://leanpub.com/praxisbuchdocs-as-code/c/SAS-Munich 88 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 86

Slide 86 text

Spicken erlaubt! ➔ embarc.de/architektur-spicker/ 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.  90 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 87

Slide 87 text

Architekturüberblicke als Vorlage ➔ embarc.de/architektur-ueberblicke/ 91 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 88

Slide 88 text

[email protected] @RalfDMueller Vielen Dank. Wir freuen uns auf Eure Fragen! [email protected] @sippsack Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc 92

Slide 89

Slide 89 text

Links/Referenzen (1) • 1×1 guter Architekturdiagramme: https://www.innoq.com/de/articles/2022/09/better-architecture- diagrams/ • Checkliste Softwarearchitekturdiagramme: https://www.feststelltaste.de/checkliste-softwarearchitekturdiagrammen/ • Praxisbuch Docs-as-Code (vorab) mit erweiterter Checkliste: https://leanpub.com/praxisbuchdocs-as-code/c/SAS-Munich • Jochem Schulenklopper „ How to improve your architectural visualizations” https://conferences.oreilly.com/software-architecture/sa-eu- 2018/public/schedule/detail/68915.html 93 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 90

Slide 90 text

Links/Referenzen (2) • Architecture diagrams should be code: https://news.ycombinator.com/item?id=34322130 • render diagrams from the Structurizr DSL: https://twitter.com/simonbrown/status/1586339632828284928?t=Q C7vjEZ5ZFcKviUWBbTk_w&s=03 • The Ultimate Guide To Software Architecture Documentation: https://www.workingsoftware.dev/software-architecture- documentation-the-ultimate-guide/?s=03 • Diagrams as code != automatic layout: https://twitter.com/simonbrown/status/1613824847812886528?t=2 DA-1BXt0iRbqCl8OyOh1g&s=03 94 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc

Slide 91

Slide 91 text

Links/Referenzen (3) • UML-Diagramme mit PlantUML: https://www.youtube.com/@Randomcode_0/search?query=plantuml • Alexander Schwartz: Technical Writing with AsciiDoc & IntelliJ https://www.udemy.com/course/technical-writing-with-asciidoc- and-intellij-idea/?couponCode=10E18DB7D7561FBBAC25 • Alexander Schwartz: Asciidoctor Deep Dive https://www.ahus1.de/post/asciidoctor-intro-and-deep-dive 95 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc