Seminar PlantUML Makros, Preprocessing und wiederverwendbare Bibliotheken

Wiederverwendung reduziert Inkonsistenzen, kann aber bei unklaren Abhängigkeiten neue Komplexität erzeugen. Das Seminar behandelt Variablen, Bedingungen, Schleifen, Prozeduren, Funktionen, Includes und Bibliotheksdesign mit dem Ziel einer transparenten und testbaren PlantUML-Codebasis.

Inhaltsverzeichnis

• Zielgruppe
• Voraussetzungen
• Lernziele
• Kapitel 1: Preprocessor-Modell und Variablen
• Kapitel 2: Prozeduren, Funktionen und Schleifen
• Kapitel 3: Include-Architektur
• Kapitel 4: Bibliotheks- und API-Design
• Kapitel 5: Tests, Versionierung und Veröffentlichung
• Durchgängiges Praxisprojekt
• Methodik

Zielgruppe

Fortgeschrittene PlantUML-Anwendende, Softwareentwickelnde, Architekten, technische Redaktionen, Plattformteams und Verantwortliche für gemeinsame Diagrammbibliotheken.

Voraussetzungen

Sichere Grundlagen in PlantUML und Erfahrung mit mehreren Diagrammdateien. Grundverständnis von Programmierung, Funktionen und Versionsverwaltung.

Lernziele

• Preprocessor-Variablen, Bedingungen, Schleifen, Prozeduren und Funktionen gezielt einsetzen
• Includes und Bibliotheken ohne unkontrollierte Abhängigkeiten strukturieren
• Makros mit klaren Parametern und stabiler Ausgabe entwerfen
• Konfiguration, Styles und fachliche Elementdefinitionen trennen
• Bibliotheken testen, versionieren und kompatibel weiterentwickeln

Kapitel 1: Preprocessor-Modell und Variablen

Das Kapitel verbindet vier aufeinander aufbauende Arbeitsschritte: Verarbeitungsreihenfolge und Gültigkeitsbereiche verstehen, Variablen für Konfiguration und Varianten definieren, Bedingungen für optionale Darstellung verwenden sowie Werte und Annahmen mit Diagnoseausgaben kontrollieren. Die Inhalte werden an einem nachvollziehbaren Beispiel aufgebaut, unmittelbar gerendert und anhand der fachlichen Aussage bewertet.

1. Schritt 1 – Analysieren: Verarbeitungsreihenfolge und Gültigkeitsbereiche verstehen.
2. Schritt 2 – Modellieren: Variablen für Konfiguration und Varianten definieren.
3. Schritt 3 – Erweitern: Bedingungen für optionale Darstellung verwenden.
4. Schritt 4 – Prüfen: Werte und Annahmen mit Diagnoseausgaben kontrollieren.

Praxisübung

Für den Schwerpunkt „Preprocessor-Modell und Variablen“ 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: Prozeduren, Funktionen und Schleifen

Das Kapitel verbindet vier aufeinander aufbauende Arbeitsschritte: wiederkehrende Quelltextmuster identifizieren, Prozeduren mit klaren Parametern entwerfen, Funktionen für berechnete Werte einsetzen sowie Schleifen nur bei nachvollziehbarer Ausgabe verwenden. Die Inhalte werden an einem nachvollziehbaren Beispiel aufgebaut, unmittelbar gerendert und anhand der fachlichen Aussage bewertet.

1. Schritt 1 – Analysieren: wiederkehrende Quelltextmuster identifizieren.
2. Schritt 2 – Modellieren: Prozeduren mit klaren Parametern entwerfen.
3. Schritt 3 – Erweitern: Funktionen für berechnete Werte einsetzen.
4. Schritt 4 – Prüfen: Schleifen nur bei nachvollziehbarer Ausgabe verwenden.

Praxisübung

Für den Schwerpunkt „Prozeduren, Funktionen und Schleifen“ 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: Include-Architektur

Das Kapitel verbindet vier aufeinander aufbauende Arbeitsschritte: lokale, gemeinsame und Standardbibliotheken unterscheiden, Include-Hierarchie und Suchpfade festlegen, Zyklen und versteckte Seiteneffekte vermeiden sowie Abhängigkeiten und erwartete Versionen dokumentieren. Die Inhalte werden an einem nachvollziehbaren Beispiel aufgebaut, unmittelbar gerendert und anhand der fachlichen Aussage bewertet.

1. Schritt 1 – Analysieren: lokale, gemeinsame und Standardbibliotheken unterscheiden.
2. Schritt 2 – Modellieren: Include-Hierarchie und Suchpfade festlegen.
3. Schritt 3 – Erweitern: Zyklen und versteckte Seiteneffekte vermeiden.
4. Schritt 4 – Prüfen: Abhängigkeiten und erwartete Versionen dokumentieren.

Praxisübung

Für den Schwerpunkt „Include-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 4: Bibliotheks- und API-Design

Das Kapitel verbindet vier aufeinander aufbauende Arbeitsschritte: öffentliche Makros von internen Hilfen trennen, Benennung, Standardwerte und Fehlerfälle definieren, Styles, Symbole und fachliche Elemente modular kapseln sowie Abwärtskompatibilität und Migrationspfade planen. Die Inhalte werden an einem nachvollziehbaren Beispiel aufgebaut, unmittelbar gerendert und anhand der fachlichen Aussage bewertet.

1. Schritt 1 – Analysieren: öffentliche Makros von internen Hilfen trennen.
2. Schritt 2 – Modellieren: Benennung, Standardwerte und Fehlerfälle definieren.
3. Schritt 3 – Erweitern: Styles, Symbole und fachliche Elemente modular kapseln.
4. Schritt 4 – Prüfen: Abwärtskompatibilität und Migrationspfade planen.

Praxisübung

Für den Schwerpunkt „Bibliotheks- und API-Design“ 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: Tests, Versionierung und Veröffentlichung

Das Kapitel verbindet vier aufeinander aufbauende Arbeitsschritte: kleine Referenzdiagramme für Bibliotheksfunktionen erstellen, Syntax und erwartete Ausgabe automatisiert prüfen, Versionen, Änderungen und Freigaben kennzeichnen sowie Bibliothek in mehreren Beispielprojekten integrieren. Die Inhalte werden an einem nachvollziehbaren Beispiel aufgebaut, unmittelbar gerendert und anhand der fachlichen Aussage bewertet.

1. Schritt 1 – Analysieren: kleine Referenzdiagramme für Bibliotheksfunktionen erstellen.
2. Schritt 2 – Modellieren: Syntax und erwartete Ausgabe automatisiert prüfen.
3. Schritt 3 – Erweitern: Versionen, Änderungen und Freigaben kennzeichnen.
4. Schritt 4 – Prüfen: Bibliothek in mehreren Beispielprojekten integrieren.

Praxisübung

Für den Schwerpunkt „Tests, Versionierung und Veröffentlichung“ 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

Eine gemeinsame Bibliothek kapselt Gestaltung, typische Systemelemente und wiederkehrende Beziehungen. Referenzdiagramme, Versionierung und ein kleiner Testlauf sichern die Verwendung in mehreren Projekten.

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.