Seminar PlantUML Grundlagen und produktiver Einstieg

Der Einstieg verbindet die textbasierte Arbeitsweise mit den wichtigsten Diagrammtypen, einer reproduzierbaren lokalen Umgebung und grundlegenden Qualitätsregeln. Statt isolierter Syntaxbeispiele entsteht schrittweise ein kleiner, versionierbarer Diagrammbestand für ein zusammenhängendes System.

Inhaltsverzeichnis

• Zielgruppe
• Voraussetzungen
• Lernziele
• Kapitel 1: Arbeitsweise und Laufzeit
• Kapitel 2: Gemeinsame Syntax und Lesbarkeit
• Kapitel 3: Interaktionen und Verhalten
• Kapitel 4: Struktur und Architektur
• Kapitel 5: Gestaltung und Wiederverwendung
• Durchgängiges Praxisprojekt
• Methodik

Zielgruppe

Softwareentwickelnde, Architekten, Business-Analysten, Test Engineers, technische Redaktionen, Projektverantwortliche und weitere Rollen mit Bedarf an wartbaren Diagrammen.

Voraussetzungen

Keine PlantUML-Vorkenntnisse erforderlich. Grundlegende Erfahrung mit Texteditoren und Dateien genügt; für die Übungen steht eine vorbereitete Arbeitsumgebung bereit.

Lernziele

• PlantUML lokal, im Editor oder über eine bereitgestellte Laufzeit sicher verwenden
• Syntaxaufbau, Elemente, Beziehungen, Notizen und gemeinsame Direktiven verstehen
• geeignete UML- und Nicht-UML-Diagrammtypen für typische Fragen auswählen
• Diagramme lesbar gestalten, modularisieren und versionieren
• Fehler systematisch finden und einen produktiven Team-Workflow aufbauen

Kapitel 1: Arbeitsweise und Laufzeit

Das Kapitel verbindet vier aufeinander aufbauende Arbeitsschritte: Textquelle, Renderer und Ausgabeformat unterscheiden, eine lokale oder bereitgestellte Umgebung prüfen, erstes Diagramm mit Start- und Endmarkierung anlegen sowie PNG- und SVG-Ausgabe erzeugen und vergleichen. 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: eine lokale oder bereitgestellte Umgebung prüfen.
3. Schritt 3 – Erweitern: erstes Diagramm mit Start- und Endmarkierung anlegen.
4. Schritt 4 – Prüfen: PNG- und SVG-Ausgabe erzeugen und vergleichen.

Praxisübung

Für den Schwerpunkt „Arbeitsweise und Laufzeit“ 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: Gemeinsame Syntax und Lesbarkeit

Das Kapitel verbindet vier aufeinander aufbauende Arbeitsschritte: Elemente, Aliase und Beziehungen benennen, Notizen, Titel, Legenden und Kommentare einsetzen, Pakete, Rechtecke und Gruppierungen verwenden sowie Fehlermeldungen lesen und minimale Korrekturen durchführen. Die Inhalte werden an einem nachvollziehbaren Beispiel aufgebaut, unmittelbar gerendert und anhand der fachlichen Aussage bewertet.

1. Schritt 1 – Analysieren: Elemente, Aliase und Beziehungen benennen.
2. Schritt 2 – Modellieren: Notizen, Titel, Legenden und Kommentare einsetzen.
3. Schritt 3 – Erweitern: Pakete, Rechtecke und Gruppierungen verwenden.
4. Schritt 4 – Prüfen: Fehlermeldungen lesen und minimale Korrekturen durchführen.

Praxisübung

Für den Schwerpunkt „Gemeinsame Syntax und Lesbarkeit“ 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: Interaktionen und Verhalten

Das Kapitel verbindet vier aufeinander aufbauende Arbeitsschritte: einen einfachen Ablauf als Sequenzdiagramm darstellen, Entscheidungen in einem Aktivitätsdiagramm modellieren, Zustände und Übergänge eines Objekts beschreiben sowie passenden Diagrammtyp anhand der Fragestellung auswählen. Die Inhalte werden an einem nachvollziehbaren Beispiel aufgebaut, unmittelbar gerendert und anhand der fachlichen Aussage bewertet.

1. Schritt 1 – Analysieren: einen einfachen Ablauf als Sequenzdiagramm darstellen.
2. Schritt 2 – Modellieren: Entscheidungen in einem Aktivitätsdiagramm modellieren.
3. Schritt 3 – Erweitern: Zustände und Übergänge eines Objekts beschreiben.
4. Schritt 4 – Prüfen: passenden Diagrammtyp anhand der Fragestellung auswählen.

Praxisübung

Für den Schwerpunkt „Interaktionen und Verhalten“ 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: Struktur und Architektur

Das Kapitel verbindet vier aufeinander aufbauende Arbeitsschritte: Klassen und Beziehungen in einer Domäne erfassen, Komponenten und Schnittstellen eines Systems skizzieren, Deployment-Knoten und technische Zuordnungen ergänzen sowie Abstraktionsniveau und Detailtiefe kontrollieren. Die Inhalte werden an einem nachvollziehbaren Beispiel aufgebaut, unmittelbar gerendert und anhand der fachlichen Aussage bewertet.

1. Schritt 1 – Analysieren: Klassen und Beziehungen in einer Domäne erfassen.
2. Schritt 2 – Modellieren: Komponenten und Schnittstellen eines Systems skizzieren.
3. Schritt 3 – Erweitern: Deployment-Knoten und technische Zuordnungen ergänzen.
4. Schritt 4 – Prüfen: Abstraktionsniveau und Detailtiefe kontrollieren.

Praxisübung

Für den Schwerpunkt „Struktur und Architektur“ 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: Gestaltung und Wiederverwendung

Das Kapitel verbindet vier aufeinander aufbauende Arbeitsschritte: Theme und grundlegende Styles anwenden, gemeinsame Einstellungen in eine Include-Datei auslagern, Namen, Pfade und Dateistruktur vereinheitlichen sowie Diagrammquellen in einer Versionsverwaltung organisieren. 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 Einstellungen in eine Include-Datei auslagern.
3. Schritt 3 – Erweitern: Namen, Pfade und Dateistruktur vereinheitlichen.
4. Schritt 4 – Prüfen: Diagrammquellen in einer Versionsverwaltung organisieren.

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.

Durchgängiges Praxisprojekt

Ein kleines Informationssystem wird mit Sequenz-, Aktivitäts-, Klassen- und Komponentensicht dokumentiert. Gemeinsame Gestaltung, Dateistruktur und eine kurze Review-Checkliste verbinden die Einzeldiagramme zu einem wartbaren Ausgangsbestand.

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.