Seminar PlantUML EBNF-, Regex- und technische Spezifikationsdiagramme

Formale Grammatiken und reguläre Ausdrücke sind präzise, aber in Rohform oft schwer zu vermitteln. Das Seminar zeigt, wie EBNF- und Regex-Darstellungen sowie ergänzende Notizen und Beispiele für technische Spezifikationen genutzt werden, ohne die fachliche Aussage zu verfälschen.

Inhaltsverzeichnis

• Zielgruppe
• Voraussetzungen
• Lernziele
• Kapitel 1: Formale Regeln und Darstellungsziel
• Kapitel 2: EBNF-Diagramme
• Kapitel 3: Regex-Diagramme
• Kapitel 4: Spezifikationspaket und Review
• Durchgängiges Praxisprojekt
• Methodik

Zielgruppe

Softwareentwickelnde, API- und Protokolldesigner, Test Engineers, technische Redaktionen, Language-Tooling-Teams und Verantwortliche für Dateiformate oder Validierungsregeln.

Voraussetzungen

Grundverständnis von Syntaxregeln, regulären Ausdrücken oder technischen Spezifikationen. PlantUML-Vorkenntnisse sind nicht erforderlich.

Lernziele

• EBNF-Regeln strukturiert visualisieren und lesbar zerlegen
• Regex-Muster in nachvollziehbare Diagramme überführen
• Diagramm, formale Regel und positive sowie negative Beispiele synchron halten
• komplexe Regeln modularisieren und gezielt kommentieren
• Spezifikationsdiagramme mit Tests und Reviews verbinden

Kapitel 1: Formale Regeln und Darstellungsziel

Das Kapitel verbindet vier aufeinander aufbauende Arbeitsschritte: Zweck, Geltungsbereich und Eingabesprache abgrenzen, Terminals, Nichtterminals und Alternativen identifizieren, Beispiele und Gegenbeispiele zur Regel sammeln sowie geeignete Diagrammform und Detailtiefe bestimmen. Die Inhalte werden an einem nachvollziehbaren Beispiel aufgebaut, unmittelbar gerendert und anhand der fachlichen Aussage bewertet.

1. Schritt 1 – Analysieren: Zweck, Geltungsbereich und Eingabesprache abgrenzen.
2. Schritt 2 – Modellieren: Terminals, Nichtterminals und Alternativen identifizieren.
3. Schritt 3 – Erweitern: Beispiele und Gegenbeispiele zur Regel sammeln.
4. Schritt 4 – Prüfen: geeignete Diagrammform und Detailtiefe bestimmen.

Praxisübung

Für den Schwerpunkt „Formale Regeln und Darstellungsziel“ 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: EBNF-Diagramme

Das Kapitel verbindet vier aufeinander aufbauende Arbeitsschritte: Produktionen und Sequenzen schrittweise erfassen, Alternativen, Wiederholungen und optionale Teile notieren, große Grammatiken in benannte Teilregeln zerlegen sowie Diagramm gegen die schriftliche Grammatik prüfen. Die Inhalte werden an einem nachvollziehbaren Beispiel aufgebaut, unmittelbar gerendert und anhand der fachlichen Aussage bewertet.

1. Schritt 1 – Analysieren: Produktionen und Sequenzen schrittweise erfassen.
2. Schritt 2 – Modellieren: Alternativen, Wiederholungen und optionale Teile notieren.
3. Schritt 3 – Erweitern: große Grammatiken in benannte Teilregeln zerlegen.
4. Schritt 4 – Prüfen: Diagramm gegen die schriftliche Grammatik prüfen.

Praxisübung

Für den Schwerpunkt „EBNF-Diagramme“ 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: Regex-Diagramme

Das Kapitel verbindet vier aufeinander aufbauende Arbeitsschritte: Musterteile und Gruppen sichtbar strukturieren, Alternativen, Quantifizierer und Zeichenklassen erklären, Anker und Randbedingungen dokumentieren sowie Muster mit positiven und negativen Testfällen abgleichen. Die Inhalte werden an einem nachvollziehbaren Beispiel aufgebaut, unmittelbar gerendert und anhand der fachlichen Aussage bewertet.

1. Schritt 1 – Analysieren: Musterteile und Gruppen sichtbar strukturieren.
2. Schritt 2 – Modellieren: Alternativen, Quantifizierer und Zeichenklassen erklären.
3. Schritt 3 – Erweitern: Anker und Randbedingungen dokumentieren.
4. Schritt 4 – Prüfen: Muster mit positiven und negativen Testfällen abgleichen.

Praxisübung

Für den Schwerpunkt „Regex-Diagramme“ 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: Spezifikationspaket und Review

Das Kapitel verbindet vier aufeinander aufbauende Arbeitsschritte: Regeln, Diagramme und Beispiele gemeinsam organisieren, Änderungen an Regeln und Tests nachvollziehbar versionieren, Mehrdeutigkeiten und unerreichbare Zweige identifizieren sowie eine technische Review-Checkliste anwenden. Die Inhalte werden an einem nachvollziehbaren Beispiel aufgebaut, unmittelbar gerendert und anhand der fachlichen Aussage bewertet.

1. Schritt 1 – Analysieren: Regeln, Diagramme und Beispiele gemeinsam organisieren.
2. Schritt 2 – Modellieren: Änderungen an Regeln und Tests nachvollziehbar versionieren.
3. Schritt 3 – Erweitern: Mehrdeutigkeiten und unerreichbare Zweige identifizieren.
4. Schritt 4 – Prüfen: eine technische Review-Checkliste anwenden.

Praxisübung

Für den Schwerpunkt „Spezifikationspaket und Review“ 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

Für ein kleines Bezeichner-, Versions- oder Nachrichtenformat entstehen eine EBNF-Beschreibung, ein Regex-Muster, passende Diagramme sowie positive und negative Testbeispiele.

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.