Seminar Eclipse Capella Dokumentation mit M2Doc

Modellbasierte Dokumentation bleibt nur dann belastbar, wenn Inhalte reproduzierbar aus dem Modell erzeugt werden. Behandelt werden Vorlagenaufbau, Abfragen, Diagrammausgabe und robuste Generierung.

Inhaltsübersicht

1. Zielsetzung
2. Zielgruppe
3. Voraussetzungen
4. Seminarinhalte
5. Praxisübungen
6. Lernorganisation
7. Einordnung im Lernpfad

Zielsetzung

Ziel ist eine wartbare M2Doc-Vorlage, die Architekturinformationen strukturiert, nachvollziehbar und wiederholbar in ein Word-Dokument überführt.

Zielgruppe

Systemingenieure, Dokumentationsverantwortliche, Toolverantwortliche und erfahrene Capella-Modellierende.

Voraussetzungen

Sicherer Umgang mit Capella-Modellen; Grundkenntnisse in Word-Formatvorlagen sind hilfreich.

Seminarinhalte

1. M2Doc-Vorlagen und Dokumentstruktur aufbauen

1. Schritt 1: Dokumentziel, Zielgruppen und benötigte Modellinformationen festlegen.
2. Schritt 2: Word-Vorlage mit Abschnitten, Formatvorlagen und Platzhaltern vorbereiten.
3. Schritt 3: M2Doc-Ausdrücke für Texte, Tabellen und Diagramme schrittweise einfügen.
4. Schritt 4: Vorlage gegen unterschiedliche Modellstände testen und stabilisieren.

2. Abfragen, Schleifen und robuste Dokumentgenerierung entwickeln

1. Schritt 1: Modellzugriffe mit geeigneten Diensten und AQL-Ausdrücken formulieren.
2. Schritt 2: Sammlungen filtern, sortieren und in Tabellen oder Abschnitten ausgeben.
3. Schritt 3: Fehlende Werte, leere Listen und optionale Diagramme defensiv behandeln.
4. Schritt 4: Generierung reproduzierbar ausführen und Ausgabe auf Vollständigkeit prüfen.

3. Diagramme, semantischen Browser und Matrizen effizient nutzen

1. Schritt 1: Zwischen semantischem Modell, Diagrammrepräsentation und Tabellenansicht unterscheiden.
2. Schritt 2: Semantischen Browser zur Analyse von Beziehungen und Auswirkungen einsetzen.
3. Schritt 3: Filter, Ebenen, Kategorien und Synchronisierung zur Lesbarkeit konfigurieren.
4. Schritt 4: Matrizen und Abfragen für Vollständigkeits- und Zuordnungsprüfungen verwenden.

4. Daten, Austauschobjekte und Informationsmodelle modellieren

1. Schritt 1: Grundtypen, Aufzählungen, Klassen und Sammlungen nach einer Modellierungsregel anlegen.
2. Schritt 2: Exchange Items strukturieren und geeignete Austauschmechanismen zuordnen.
3. Schritt 3: Datenbeziehungen, Multiplizitäten und Eigentumsverhältnisse konsistent definieren.
4. Schritt 4: Verwendung der Datentypen in Funktionen, Schnittstellen und Szenarien prüfen.

5. Validierungsregeln, Profile und Schnellkorrekturen einsetzen

1. Schritt 1: Integritäts-, Design-, Vollständigkeits- und Traceability-Prüfungen unterscheiden.
2. Schritt 2: Passendes Validierungsprofil für Modellierungsphase und Reviewziel auswählen.
3. Schritt 3: Befunde priorisieren, Ursachen analysieren und Schnellkorrekturen kontrolliert anwenden.
4. Schritt 4: Restbefunde begründen und als überprüfbare Qualitätsentscheidung dokumentieren.

Praxisübungen

• Eine kompakte Architekturbeschreibung aus einer selbst erstellten M2Doc-Vorlage erzeugen.
• Eine mehrstufige Tabelle mit Funktionen, Komponenten und Schnittstellen automatisch erzeugen.
• Eine unübersichtliche Diagrammlandschaft strukturieren und einen prüffähigen Navigationsweg definieren.
• Ein kleines Informationsmodell erstellen und in zwei Schnittstellen konsistent verwenden.
• Ein Modell mit einem angepassten Prüfprofil validieren und einen Befundbericht erstellen.

Lernorganisation

Jede Vorlagenfunktion wird zunächst isoliert getestet und anschließend in ein zusammenhängendes Dokument integriert. Qualitätssicherung erfolgt über definierte Testmodelle.

Einordnung im Lernpfad

Sinnvoll nach sicherer Capella-Modellierung; Python4Capella ergänzt das Thema um frei programmierbare Exporte.