Share
Phantastische Diagramme und wie Du sie selbst erstellst
Die wichtigste Aufgabe eines Software-Architekten besteht darin, die Architektur zu kommunizieren.
JavaLand 2023, Brühl, zusammen mit Falk Sippach
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.
Ralf D. Müller
Transcript
91 slides
-
Phantastische Diagramme …und wie Du sie selbst erstellst Falk Sippach
embarc Ralf D. Müller DB Systel GmbH -
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 -
[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 -
[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 -
JavaLand 2023 Wer seid Ihr? 7 https://forms.gle/Ejsgzp1BFoBrB9Hs6 Ralf D. Müller
| @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc -
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 -
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 -
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 -
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? -
Ein Bild sagt mehr als 1000 Worte … 12 Ralf
D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc -
Agenda Werkzeuge Gute Diagramme 13 Ralf D. Müller | @ralfdmueller
| DB Systel Falk Sippach | @sippsack | embarc Einbettung in Dokumentation -
Agenda Werkzeuge Gute Diagramme 14 Ralf D. Müller | @ralfdmueller
| DB Systel Falk Sippach | @sippsack | embarc Einbettung in Dokumentation -
Einleitung Qualitätskriterien ? 15 Ralf D. Müller | @ralfdmueller |
DB Systel Falk Sippach | @sippsack | embarc -
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 -
„All Models are Wrong but some are Useful“ George Box
17 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc -
Was ist ein Modell? Bild von Hans Benn auf Pixabay
18 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc -
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 -
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 -
Visual Style 21 Ralf D. Müller | @ralfdmueller | DB
Systel Falk Sippach | @sippsack | embarc -
Ein Beispiel 22 Ralf D. Müller | @ralfdmueller | DB
Systel Falk Sippach | @sippsack | embarc -
Farben 23 Ralf D. Müller | @ralfdmueller | DB Systel
Falk Sippach | @sippsack | embarc -
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 -
Größe 25 Ralf D. Müller | @ralfdmueller | DB Systel
Falk Sippach | @sippsack | embarc -
Pfeilrichtung 26 Ralf D. Müller | @ralfdmueller | DB Systel
Falk Sippach | @sippsack | embarc -
Linienstärke 27 Ralf D. Müller | @ralfdmueller | DB Systel
Falk Sippach | @sippsack | embarc -
Text-Stile 28 Ralf D. Müller | @ralfdmueller | DB Systel
Falk Sippach | @sippsack | embarc -
Beschriftung 29 Ralf D. Müller | @ralfdmueller | DB Systel
Falk Sippach | @sippsack | embarc -
Abstraktionslevel 30 Ralf D. Müller | @ralfdmueller | DB Systel
Falk Sippach | @sippsack | embarc -
Legende 31 Ralf D. Müller | @ralfdmueller | DB Systel
Falk Sippach | @sippsack | embarc -
Landscape 32 Ralf D. Müller | @ralfdmueller | DB Systel
Falk Sippach | @sippsack | embarc -
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 -
c4model.com 35 Ralf D. Müller | @ralfdmueller | DB Systel
Falk Sippach | @sippsack | embarc -
c4model.com: Context 36 Ralf D. Müller | @ralfdmueller | DB
Systel Falk Sippach | @sippsack | embarc -
c4model.com: Containers 37 Ralf D. Müller | @ralfdmueller | DB
Systel Falk Sippach | @sippsack | embarc -
c4model.com: Components 38 Ralf D. Müller | @ralfdmueller | DB
Systel Falk Sippach | @sippsack | embarc -
c4model.com: Classes Quelle der C4-Diagramme c4model.com 39 Ralf D. Müller
| @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc -
c4model.com Quelle der C4-Diagramme c4model.com 40 Ralf D. Müller |
@ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc -
Agenda Werkzeuge Gute Diagramme 41 Ralf D. Müller | @ralfdmueller
| DB Systel Falk Sippach | @sippsack | embarc Einbettung in Dokumentation -
PlantUML 42 Ralf D. Müller | @ralfdmueller | DB Systel
Falk Sippach | @sippsack | embarc -
Diagramme: PlantUML 43 Ralf D. Müller | @ralfdmueller | DB
Systel Falk Sippach | @sippsack | embarc -
Diagramme: PlantUML 44 Ralf D. Müller | @ralfdmueller | DB
Systel Falk Sippach | @sippsack | embarc -
Diagrams.net 45 Ralf D. Müller | @ralfdmueller | DB Systel
Falk Sippach | @sippsack | embarc -
Diagrams.net PNG-Diagramm <xml> … </xml> Meta-Daten 46 Ralf D. Müller
| @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc -
https://kroki.io/ 47 Ralf D. Müller | @ralfdmueller | DB Systel
Falk Sippach | @sippsack | embarc -
https://vega.github.io/vega/ 48 Ralf D. Müller | @ralfdmueller | DB Systel
Falk Sippach | @sippsack | embarc -
Diagramme: Nicht malen, modellieren! 49 Ralf D. Müller | @ralfdmueller
| DB Systel Falk Sippach | @sippsack | embarc -
{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 -
=== Stakeholder ==== Users and Groups of Users image::ea/1.5_Stakeholder.png[] [cols="2,3,3,2"
options="header"] .Users and Groups of Users |=== | Role | Description | Goal | Comment include::../../ea/stakeholder.ad[] |=== treat Docs-as-Code: automate! 51 Ralf D. Müller | @ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc -
52 treat Docs-as-Code: automate! Ralf D. Müller | @ralfdmueller |
DB Systel Falk Sippach | @sippsack | embarc -
Agenda Werkzeuge Gute Diagramme 53 Ralf D. Müller | @ralfdmueller
| DB Systel Falk Sippach | @sippsack | embarc Einbettung in Dokumentation -
Analogie Bauwesen 54 Ansicht Schnitt Grundriss Ralf D. Müller |
@ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc -
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 -
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 -
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 -
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 -
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 -
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 -
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 -
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 -
Beispiel eines Ablaufes 63 https://www.dokchess.de/ Ralf D. Müller | @ralfdmueller
| DB Systel Falk Sippach | @sippsack | embarc -
Beispiel eines Ablaufes 64 https://www.dokchess.de/ Ralf D. Müller | @ralfdmueller
| DB Systel Falk Sippach | @sippsack | embarc -
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 -
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 -
Waren das schon alle Sichten? 67 Ralf D. Müller |
@ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc -
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 -
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 -
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 -
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 -
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 -
Beispiele Umsetzung in diagrams.net 73 Ralf D. Müller | @ralfdmueller
| DB Systel Falk Sippach | @sippsack | embarc -
Documentation-as-Code Ablage im Repo Versionier- /Diffbar Synchrone Auslieferung Offlinefähig Teil
des Build- Prozesses Generierung/ Automatisierung Flexible Ausgabe Nähe zum Sourcecode -
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 -
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 -
Docs-as-Code in der IDE – eine besondere Liebe ❤️🥰 Syntax-Highlighting,
… Autovervollständigung, Modularisierung, … Diagrams-as-Code mit PlantUML, Vorschau, … Draw.io inside … -
Ausblick Werkzeuge Gute Diagramme 81 Ralf D. Müller | @ralfdmueller
| DB Systel Falk Sippach | @sippsack | embarc Einbettung in Dokumentation -
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 -
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 -
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 -
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 -
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 -
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 -
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 -
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 -
Architekturüberblicke als Vorlage ➔ embarc.de/architektur-ueberblicke/ 91 Ralf D. Müller |
@ralfdmueller | DB Systel Falk Sippach | @sippsack | embarc -
[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 -
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 -
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 -
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