Seminar PlantUML Kompakt – Diagramme, Architektur und Automation

Das Kompaktseminar vermittelt einen belastbaren Querschnitt durch das Gesamtportfolio. Es verbindet zentrale UML-Diagramme, Architektur- und Datenansichten, Gestaltung, Wiederverwendung, Documentation-as-Code und einen einfachen automatisierten Build in einem dreitägigen Praxisprogramm.

Inhaltsverzeichnis

• Zielgruppe
• Voraussetzungen
• Lernziele
• Kapitel 1: Arbeitsweise und Grundsyntax
• Kapitel 2: Sequenz- und Aktivitätsdiagramme
• Kapitel 3: Klassen, Komponenten und Deployment
• Kapitel 4: C4 und Architekturkommunikation
• Kapitel 5: Daten und Nicht-UML-Sichten
• Kapitel 6: Gestaltung und Wiederverwendung
• Kapitel 7: Documentation-as-Code
• Kapitel 8: Automation und Abschlussprojekt
• Durchgängiges Praxisprojekt
• Methodik

Zielgruppe

Fach- und Führungskräfte mit technischem Bezug, Softwareentwickelnde, Architekten, Business-Analysten, Test Engineers und technische Redaktionen, die in kurzer Zeit einen breiten Überblick mit praktischer Anwendung benötigen.

Voraussetzungen

Allgemeines Verständnis von Software- oder Prozessdokumentation. PlantUML-Vorkenntnisse sind nicht erforderlich; Grundkenntnisse in Versionsverwaltung erleichtern den Automationsteil.

Lernziele

• PlantUML-Arbeitsweise, Syntax und geeignete Diagrammtypen sicher einordnen
• Interaktion, Verhalten, Struktur und Architektur in ausgewählten Sichten modellieren
• Diagramme gestalten, modularisieren und in Dokumentationsquellen einbetten
• einen einfachen reproduzierbaren Build mit Syntaxprüfung aufsetzen
• für weiterführende Einzelseminare oder Intensivprogramme einen passenden Lernpfad auswählen

Kapitel 1: Arbeitsweise und Grundsyntax

Das Kapitel verbindet vier aufeinander aufbauende Arbeitsschritte: Textquelle, Renderer und Ausgabeformat unterscheiden, erstes Diagramm anlegen und lokal rendern, Elemente, Beziehungen, Notizen und Gruppierungen verwenden sowie Fehlermeldungen lesen und Quelltext korrigieren. Die Inhalte werden an einem nachvollziehbaren Beispiel aufgebaut, unmittelbar gerendert und anhand der fachlichen Aussage bewertet.

1. Schritt 1 – Analysieren: Textquelle, Renderer und Ausgabeformat unterscheiden.
2. Schritt 2 – Modellieren: erstes Diagramm anlegen und lokal rendern.
3. Schritt 3 – Erweitern: Elemente, Beziehungen, Notizen und Gruppierungen verwenden.
4. Schritt 4 – Prüfen: Fehlermeldungen lesen und Quelltext korrigieren.

Praxisübung

Für den Schwerpunkt „Arbeitsweise und Grundsyntax“ entsteht ein eigenständiges Teilmodell. Anschließend werden Syntax, Semantik, Lesbarkeit und Anschlussfähigkeit an das Gesamtprojekt mit einer kompakten Prüfliste kontrolliert.

Kapitel 2: Sequenz- und Aktivitätsdiagramme

Das Kapitel verbindet vier aufeinander aufbauende Arbeitsschritte: Interaktionspartner und Nachrichtenfolge erfassen, Alternativen und Schleifen in Sequenzen darstellen, Abläufe, Entscheidungen und Parallelität modellieren sowie Interaktions- und Prozesssicht aufeinander beziehen. Die Inhalte werden an einem nachvollziehbaren Beispiel aufgebaut, unmittelbar gerendert und anhand der fachlichen Aussage bewertet.

1. Schritt 1 – Analysieren: Interaktionspartner und Nachrichtenfolge erfassen.
2. Schritt 2 – Modellieren: Alternativen und Schleifen in Sequenzen darstellen.
3. Schritt 3 – Erweitern: Abläufe, Entscheidungen und Parallelität modellieren.
4. Schritt 4 – Prüfen: Interaktions- und Prozesssicht aufeinander beziehen.

Praxisübung

Für den Schwerpunkt „Sequenz- und Aktivitätsdiagramme“ entsteht ein eigenständiges Teilmodell. Anschließend werden Syntax, Semantik, Lesbarkeit und Anschlussfähigkeit an das Gesamtprojekt mit einer kompakten Prüfliste kontrolliert.

Kapitel 3: Klassen, Komponenten und Deployment

Das Kapitel verbindet vier aufeinander aufbauende Arbeitsschritte: fachliche Klassen und Beziehungen identifizieren, Komponenten und Schnittstellen aus Verantwortlichkeiten ableiten, Laufzeitknoten und Artefakte ergänzen sowie Struktur- und Betriebssicht konsistent halten. Die Inhalte werden an einem nachvollziehbaren Beispiel aufgebaut, unmittelbar gerendert und anhand der fachlichen Aussage bewertet.

1. Schritt 1 – Analysieren: fachliche Klassen und Beziehungen identifizieren.
2. Schritt 2 – Modellieren: Komponenten und Schnittstellen aus Verantwortlichkeiten ableiten.
3. Schritt 3 – Erweitern: Laufzeitknoten und Artefakte ergänzen.
4. Schritt 4 – Prüfen: Struktur- und Betriebssicht konsistent halten.

Praxisübung

Für den Schwerpunkt „Klassen, Komponenten und Deployment“ entsteht ein eigenständiges Teilmodell. Anschließend werden Syntax, Semantik, Lesbarkeit und Anschlussfähigkeit an das Gesamtprojekt mit einer kompakten Prüfliste kontrolliert.

Kapitel 4: C4 und Architekturkommunikation

Das Kapitel verbindet vier aufeinander aufbauende Arbeitsschritte: Systemkontext und externe Abhängigkeiten bestimmen, Container und technologische Verantwortungsgrenzen modellieren, passende Detailtiefe für Stakeholder auswählen sowie eine Architekturübersicht mit Legende und Technologieangaben erstellen. Die Inhalte werden an einem nachvollziehbaren Beispiel aufgebaut, unmittelbar gerendert und anhand der fachlichen Aussage bewertet.

1. Schritt 1 – Analysieren: Systemkontext und externe Abhängigkeiten bestimmen.
2. Schritt 2 – Modellieren: Container und technologische Verantwortungsgrenzen modellieren.
3. Schritt 3 – Erweitern: passende Detailtiefe für Stakeholder auswählen.
4. Schritt 4 – Prüfen: eine Architekturübersicht mit Legende und Technologieangaben erstellen.

Praxisübung

Für den Schwerpunkt „C4 und Architekturkommunikation“ entsteht ein eigenständiges Teilmodell. Anschließend werden Syntax, Semantik, Lesbarkeit und Anschlussfähigkeit an das Gesamtprojekt mit einer kompakten Prüfliste kontrolliert.

Kapitel 5: Daten und Nicht-UML-Sichten

Das Kapitel verbindet vier aufeinander aufbauende Arbeitsschritte: Entitäten und Kardinalitäten skizzieren, JSON- oder YAML-Strukturen visualisieren, Mindmap, WBS oder Gantt für Planungsfragen einsetzen sowie Diagrammtyp anhand Informationsziel und Pflegeaufwand auswählen. Die Inhalte werden an einem nachvollziehbaren Beispiel aufgebaut, unmittelbar gerendert und anhand der fachlichen Aussage bewertet.

1. Schritt 1 – Analysieren: Entitäten und Kardinalitäten skizzieren.
2. Schritt 2 – Modellieren: JSON- oder YAML-Strukturen visualisieren.
3. Schritt 3 – Erweitern: Mindmap, WBS oder Gantt für Planungsfragen einsetzen.
4. Schritt 4 – Prüfen: Diagrammtyp anhand Informationsziel und Pflegeaufwand auswählen.

Praxisübung

Für den Schwerpunkt „Daten und Nicht-UML-Sichten“ entsteht ein eigenständiges Teilmodell. Anschließend werden Syntax, Semantik, Lesbarkeit und Anschlussfähigkeit an das Gesamtprojekt mit einer kompakten Prüfliste kontrolliert.

Kapitel 6: Gestaltung und Wiederverwendung

Das Kapitel verbindet vier aufeinander aufbauende Arbeitsschritte: Theme und grundlegende Styles anwenden, gemeinsame Farben, Legenden und Aliase definieren, wiederkehrende Elemente in Include-Dateien auslagern sowie Dateistruktur und Namenskonventionen vereinheitlichen. Die Inhalte werden an einem nachvollziehbaren Beispiel aufgebaut, unmittelbar gerendert und anhand der fachlichen Aussage bewertet.

1. Schritt 1 – Analysieren: Theme und grundlegende Styles anwenden.
2. Schritt 2 – Modellieren: gemeinsame Farben, Legenden und Aliase definieren.
3. Schritt 3 – Erweitern: wiederkehrende Elemente in Include-Dateien auslagern.
4. Schritt 4 – Prüfen: Dateistruktur und Namenskonventionen vereinheitlichen.

Praxisübung

Für den Schwerpunkt „Gestaltung und Wiederverwendung“ entsteht ein eigenständiges Teilmodell. Anschließend werden Syntax, Semantik, Lesbarkeit und Anschlussfähigkeit an das Gesamtprojekt mit einer kompakten Prüfliste kontrolliert.

Kapitel 7: Documentation-as-Code

Das Kapitel verbindet vier aufeinander aufbauende Arbeitsschritte: Diagramme in Markdown oder AsciiDoc einbetten, relative Pfade und Ausgabeformate organisieren, Text- und Diagrammänderungen gemeinsam versionieren sowie Dokumentationspaket lokal reproduzierbar erzeugen. Die Inhalte werden an einem nachvollziehbaren Beispiel aufgebaut, unmittelbar gerendert und anhand der fachlichen Aussage bewertet.

1. Schritt 1 – Analysieren: Diagramme in Markdown oder AsciiDoc einbetten.
2. Schritt 2 – Modellieren: relative Pfade und Ausgabeformate organisieren.
3. Schritt 3 – Erweitern: Text- und Diagrammänderungen gemeinsam versionieren.
4. Schritt 4 – Prüfen: Dokumentationspaket lokal reproduzierbar erzeugen.

Praxisübung

Für den Schwerpunkt „Documentation-as-Code“ entsteht ein eigenständiges Teilmodell. Anschließend werden Syntax, Semantik, Lesbarkeit und Anschlussfähigkeit an das Gesamtprojekt mit einer kompakten Prüfliste kontrolliert.

Kapitel 8: Automation und Abschlussprojekt

Das Kapitel verbindet vier aufeinander aufbauende Arbeitsschritte: Kommandozeilenaufruf für mehrere Diagramme definieren, Syntaxfehler als Build-Fehler behandeln, gerenderte Artefakte strukturiert ablegen sowie mehrere Sichten zu einem kleinen Dokumentationsrepository verbinden. Die Inhalte werden an einem nachvollziehbaren Beispiel aufgebaut, unmittelbar gerendert und anhand der fachlichen Aussage bewertet.

1. Schritt 1 – Analysieren: Kommandozeilenaufruf für mehrere Diagramme definieren.
2. Schritt 2 – Modellieren: Syntaxfehler als Build-Fehler behandeln.
3. Schritt 3 – Erweitern: gerenderte Artefakte strukturiert ablegen.
4. Schritt 4 – Prüfen: mehrere Sichten zu einem kleinen Dokumentationsrepository verbinden.

Praxisübung

Für den Schwerpunkt „Automation und Abschlussprojekt“ entsteht ein eigenständiges Teilmodell. Anschließend werden Syntax, Semantik, Lesbarkeit und Anschlussfähigkeit an das Gesamtprojekt mit einer kompakten Prüfliste kontrolliert.

Durchgängiges Praxisprojekt

Ein kompaktes Systemdossier entsteht aus Sequenz-, Aktivitäts-, Klassen-, C4- und Datensicht. Gemeinsame Styles, Include-Datei, Markdown- oder AsciiDoc-Seite und ein automatisierter Renderaufruf machen das Ergebnis unmittelbar weiterverwendbar.

Methodik

Fachimpulse, Live-Coding, kommentierte Demonstrationen und schrittweise Übungen wechseln sich ab. Jede neue Technik wird zunächst an einem Minimalbeispiel geprüft, danach in das Gesamtprojekt übernommen und abschließend in einem strukturierten Review bewertet. Alle Übungen verwenden versionierbare Textquellen und reproduzierbare Render-Schritte.