Seminar Obeo SmartEA – M2Doc Dokumentgenerierung und Berichtswesen

M2Doc verbindet Repository-Daten mit strukturierten Dokumentvorlagen. Das Seminar zeigt, wie wiederholbare Berichte mit Text, Tabellen, Listen und Diagrammen aufgebaut, parametrisiert, getestet und kontrolliert veröffentlicht werden.

Inhaltsverzeichnis

1. Seminarziel
2. Zielgruppe
3. Voraussetzungen
4. Seminarinhalte
5. 1. Berichtsauftrag und Datenbedarf
6. 2. M2Doc-Vorlage strukturieren
7. 3. AQL-Datenzugriffe
8. 4. Schleifen, Bedingungen und Tabellen
9. 5. Diagramme und Abbildungen
10. 6. Fehleranalyse und Testverfahren
11. 7. Veröffentlichung und Governance
12. Praxisübungen
13. Einordnung in den Lernpfad

Seminarziel

Dokumentvorlagen können aus fachlichen Berichtsanforderungen abgeleitet und mit SmartEA-Daten verbunden werden. Teilnehmer können Abfragen, Schleifen, Bedingungen, Bilder und Qualitätssicherungen so einsetzen, dass reproduzierbare Dokumente entstehen.

Zielgruppe

Enterprise Architects, Reporting-Verantwortliche, SmartEA-Customizer, funktionale Administration, Dokumentations- und Qualitätsmanagement.

Voraussetzungen

Sichere SmartEA-Bedienung, Grundkenntnisse von AQL sowie Erfahrung mit strukturierten Textdokumenten und Berichtsvorlagen.

Seminarinhalte

Die Inhalte werden in einer festen Arbeitsfolge vermittelt: Ausgangslage klären, Funktion oder Methode demonstrieren, den Vorgang am System ausführen, das Ergebnis prüfen und die Vorgehensweise dokumentieren.

1. Berichtsauftrag und Datenbedarf

Der Themenblock wird anhand eines zusammenhängenden Repository- und Projektszenarios bearbeitet.

1. Schritt 1: Zielgruppe, Entscheidung und Veröffentlichungszweck bestimmen.
2. Schritt 2: Benötigte Kapitel, Tabellen und Diagramme festlegen.
3. Schritt 3: Datenquellen und Qualitätsvoraussetzungen dokumentieren.
4. Schritt 4: Parameter und Varianten des Berichts definieren.

2. M2Doc-Vorlage strukturieren

Der Themenblock wird anhand eines zusammenhängenden Repository- und Projektszenarios bearbeitet.

1. Schritt 1: Dokument mit Überschriften, Formatvorlagen und wiederkehrenden Bereichen aufbauen.
2. Schritt 2: Platzhalter an den richtigen Kontext binden.
3. Schritt 3: Formatierung von Inhalt und Logik trennen.
4. Schritt 4: Vorlage mit einem kleinen Beispieldatensatz testen.

3. AQL-Datenzugriffe

Der Themenblock wird anhand eines zusammenhängenden Repository- und Projektszenarios bearbeitet.

1. Schritt 1: Startobjekt und Ausführungskontext bestimmen.
2. Schritt 2: Attribute und Beziehungen gezielt abfragen.
3. Schritt 3: Sammlungen filtern und sortieren.
4. Schritt 4: Leere oder unvollständige Daten kontrolliert behandeln.

4. Schleifen, Bedingungen und Tabellen

Der Themenblock wird anhand eines zusammenhängenden Repository- und Projektszenarios bearbeitet.

1. Schritt 1: Wiederholungsbereiche für Elementmengen anlegen.
2. Schritt 2: Bedingte Abschnitte für Status oder Varianten definieren.
3. Schritt 3: Tabellenspalten und Zeilen aus Repository-Daten erzeugen.
4. Schritt 4: Seitenumbrüche und lange Inhalte robust gestalten.

5. Diagramme und Abbildungen

Der Themenblock wird anhand eines zusammenhängenden Repository- und Projektszenarios bearbeitet.

1. Schritt 1: Benötigte Diagramme eindeutig referenzieren.
2. Schritt 2: Bildgröße und Beschriftung für den Zielkanal festlegen.
3. Schritt 3: Fehlende oder veraltete Diagramme erkennen.
4. Schritt 4: Abbildungsverzeichnis und Verweise konsistent halten.

6. Fehleranalyse und Testverfahren

Der Themenblock wird anhand eines zusammenhängenden Repository- und Projektszenarios bearbeitet.

1. Schritt 1: Template-, AQL- und Datenfehler voneinander unterscheiden.
2. Schritt 2: Kleine Testfälle für einzelne Vorlagenbausteine erstellen.
3. Schritt 3: Grenzfälle mit leeren Mengen und Sonderzeichen prüfen.
4. Schritt 4: Regressionstest für freigegebene Berichtsvorlagen dokumentieren.

7. Veröffentlichung und Governance

Der Themenblock wird anhand eines zusammenhängenden Repository- und Projektszenarios bearbeitet.

1. Schritt 1: Version, Eigentümer und Freigabestatus der Vorlage festlegen.
2. Schritt 2: Berichtserzeugung und Ablage standardisieren.
3. Schritt 3: Vertrauliche Inhalte und Empfängerkreis kontrollieren.
4. Schritt 4: Änderungs- und Archivierungsregeln für Vorlagen anwenden.

Praxisübungen

• Erstellung einer M2Doc-Vorlage mit Deckblatt, Inhaltsverzeichnis und Repository-Tabelle.
• Einbau von AQL-Filterung, Schleifen und bedingten Abschnitten.
• Einbindung eines SmartEA-Diagramms mit Beschriftung.
• Entwicklung eines Test- und Freigabeverfahrens für Berichtsvorlagen.

Einordnung in den Lernpfad

Empfohlen nach „AQL, Smart Requests und intelligente Suche“ und „Diagramme, Sichten und Visualisierung“. Vertiefung im Intensivseminar „Customizing, Integration und Automatisierung“.