Seminar Modelio – Dokumentation und Modellpublikation

Beschreibung

Das Seminar behandelt die systematische Erzeugung und Freigabe von Dokumenten aus Modelio-Modellen. Auswahlregeln, Dokumentvorlagen, navigierbare Publikationen, Diagrammqualität, Versionskennzeichnung und Abnahme werden zu einem reproduzierbaren Publikationsprozess verbunden.

Formatbegründung: Zwei Tage sind erforderlich, um zunächst Dokumentstruktur und Vorlagen aufzubauen und danach mehrere Ausgabeformen, Qualitätskontrollen sowie einen wiederholbaren Freigabeprozess praktisch zu testen.

Zielgruppe

Architekten, Business Analysts, technische Redaktion, Qualitätsmanagement und Modellverantwortliche.

Voraussetzungen

Sichere Modelio-Bedienung und ein strukturiertes Beispielmodell. Die benötigten Publikationsfunktionen müssen in Edition und Modulausstattung verfügbar sein.

Inhaltsübersicht

1. Dokumentationsziel und Publikationsstrategie
2. Dokumentvorlagen und Modellselektion
3. Stakeholder-Sichten und Kommunikationsmodelle
4. HTML-Publikation und navigierbare Modelldokumentation
5. Publikationsprüfung und Freigabe
6. Versionen, Baselines und Änderungsstände

Seminarinhalte

1. Dokumentationsziel und Publikationsstrategie

Dokumente werden aus klar definierten Modellinhalten, Sichten und Verantwortlichkeiten erzeugt.

1. Adressaten, Dokumentzweck, Geltungsbereich, Freigabe und Aktualisierungsrhythmus festlegen.
2. Quellmodelle, Diagramme, Tabellen und erläuternde Texte auswählen.
3. Dokumentstruktur mit Kapiteln, Auswahlregeln und Wiederverwendung entwerfen.
4. Vollständigkeit und Änderbarkeit anhand eines repräsentativen Modellbereichs prüfen.

2. Dokumentvorlagen und Modellselektion

Vorlagen verbinden wiederholbare Struktur mit gezielter Auswahl aus dem Modell.

1. Kapitelstruktur, Überschriftenebenen, Listen, Tabellen und Diagrammplatzierung definieren.
2. Auswahlregeln für Pakete, Stereotype, Status und Beziehungstypen konfigurieren.
3. Vorlage mit kleinen und großen Modellausschnitten testen.
4. Fehlende Inhalte, unerwünschte Wiederholungen und Formatabweichungen bereinigen.

3. Stakeholder-Sichten und Kommunikationsmodelle

Aus einem gemeinsamen Modell entstehen adressatengerechte Sichten für Fachbereich, Architektur, Entwicklung und Betrieb.

1. Informationsbedarf und Entscheidungsfrage der jeweiligen Zielgruppe bestimmen.
2. Relevante Elemente auswählen und fachliche, logische sowie technische Details angemessen verdichten.
3. Mehrere Sichten über gemeinsame Modellelemente konsistent halten.
4. Verständlichkeit in einem moderierten Review testen und Änderungsbedarf protokollieren.

4. HTML-Publikation und navigierbare Modelldokumentation

Navigierbare Ausgaben unterstützen Recherche, Review und verteilte Abstimmung.

1. Publikationsumfang, Startseite, Navigation und sichtbare Modelleigenschaften festlegen.
2. HTML-Ausgabe für einen freigegebenen Modellstand erzeugen.
3. Navigation, Querverweise, Diagramme und Suchbarkeit stichprobenartig prüfen.
4. Ablage, Zugriffsrechte, Version und Kennzeichnung des Modellstands dokumentieren.

5. Publikationsprüfung und Freigabe

Erzeugte Dokumente werden sowohl fachlich als auch technisch abgenommen.

1. Prüfkriterien für Vollständigkeit, Aktualität, Lesbarkeit, Vertraulichkeit und Nachverfolgbarkeit festlegen.
2. Dokument gegen Quellmodell und freigegebene Auswahlregeln vergleichen.
3. Defekte Querverweise, leere Kapitel, unlesbare Diagramme und veraltete Texte korrigieren.
4. Dokumentversion, Modellstand, Freigabe und bekannte Einschränkungen protokollieren.

6. Versionen, Baselines und Änderungsstände

Releases und Meilensteine werden als reproduzierbare Modellstände verwaltet.

1. Versionierungsobjekt, Namensschema und Freigabepunkte bestimmen.
2. Baseline vor einer größeren Änderung erzeugen.
3. Änderungsstand mit verantwortlichem Arbeitspaket und Zielversion verknüpfen.
4. Wiederherstellung oder Vergleich mit der Baseline praktisch prüfen.

Praxisübungen

• Erstellung einer Dokumentstruktur für Architektur- oder Prozessdokumentation.
• Konfiguration einer selektiven Vorlage nach Paket, Status und Stereotyp.
• Erzeugung und Prüfung einer navigierbaren Modellpublikation.
• Freigabecheck mit Modellstand, Dokumentversion und Restabweichungen.

Qualitätskriterien

• Modellelemente werden im Modellbaum eindeutig strukturiert und in Diagrammen wiederverwendet statt dupliziert.
• Beziehungen, Status, Benennung und Verantwortlichkeiten sind nachvollziehbar und entsprechen dem vereinbarten Modellierungsrahmen.
• Audit- und Reviewbefunde werden priorisiert, korrigiert und in einer erneuten Prüfung verifiziert.
• Übungsergebnisse lassen sich nach Schließen und erneutem Öffnen des Projekts reproduzierbar nachvollziehen.
• Die fachlichen Abnahmepunkte des Bereichs Dokumentation werden anhand des Übungsprojekts vollständig geprüft.