Seminar Eclipse Papyrus – Model2Doc und automatisierte Modelldokumentation

Das Seminar zeigt, wie aus Papyrus-Modellen reproduzierbare Dokumente erzeugt werden. Inhaltsauswahl, Dokumentstruktur, Vorlagen, Abbildungen, Tabellen, Querverweise, Ausgabeformate und Qualitätsprüfungen werden zu einem wartbaren Generierungsprozess verbunden.

Inhaltsverzeichnis

• Lernziele und fachliche Einordnung
• Schrittweise Seminarinhalte
• Praxisübungen und Laborszenarien
• Zielgruppe und Voraussetzungen
• Didaktik und Arbeitsweise

Lernziele

• Informationsbedarf und Dokumentstruktur aus einem Modellierungszweck ableiten.
• Modellinhalte gezielt auswählen, ordnen und in Dokumentbausteine überführen.
• Vorlagen für Text, Diagramme, Tabellen und Querverweise konfigurieren.
• Dokumente in mehreren Ausgabeformaten reproduzierbar erzeugen.
• Qualitätskontrollen und einen wartbaren Generierungsworkflow etablieren.

Schrittweise Seminarinhalte

1. Dokumentationsziel und Informationsmodell

Schwerpunkt: Adressaten, Dokumenttypen, Kapitelstruktur, Modellbereiche und Aktualisierungsregeln.

1. Adressaten, Informationsbedarf und Qualitätskriterien für den Themenblock „Dokumentationsziel und Informationsmodell“ festlegen.
2. Folgende Dokumentelemente und Modellbezüge werden strukturiert: Adressaten, Dokumenttypen, Kapitelstruktur, Modellbereiche und Aktualisierungsregeln.
3. Vorlagen, Abfragen und Generierungsschritte schrittweise konfigurieren und ausführen.
4. Vollständigkeit, Aktualität, Layout, Querverweise und Wiederholbarkeit anhand eines Prüfkatalogs kontrollieren.
5. Als Arbeitsergebnis eine freigegebene Dokumentationsstruktur versionieren und für wiederholte Generierungen bereitstellen.

2. Model2Doc-Projekt und Dokumentmodell

Schwerpunkt: Dokumentobjekte, Abschnitte, Abfragen, Reihenfolge, Filter und Modellbezüge.

1. Adressaten, Informationsbedarf und Qualitätskriterien für den Themenblock „Model2Doc-Projekt und Dokumentmodell“ festlegen.
2. Folgende Dokumentelemente und Modellbezüge werden strukturiert: Dokumentobjekte, Abschnitte, Abfragen, Reihenfolge, Filter und Modellbezüge.
3. Vorlagen, Abfragen und Generierungsschritte schrittweise konfigurieren und ausführen.
4. Vollständigkeit, Aktualität, Layout, Querverweise und Wiederholbarkeit anhand eines Prüfkatalogs kontrollieren.
5. Als Arbeitsergebnis ein ausführbares Dokumentmodell versionieren und für wiederholte Generierungen bereitstellen.

3. Vorlagen, Abbildungen und Tabellen

Schwerpunkt: Formatvorlagen, Diagrammexport, Tabellen, Beschriftungen, Querverweise und wiederverwendbare Bausteine.

1. Adressaten, Informationsbedarf und Qualitätskriterien für den Themenblock „Vorlagen, Abbildungen und Tabellen“ festlegen.
2. Folgende Dokumentelemente und Modellbezüge werden strukturiert: Formatvorlagen, Diagrammexport, Tabellen, Beschriftungen, Querverweise und wiederverwendbare Bausteine.
3. Vorlagen, Abfragen und Generierungsschritte schrittweise konfigurieren und ausführen.
4. Vollständigkeit, Aktualität, Layout, Querverweise und Wiederholbarkeit anhand eines Prüfkatalogs kontrollieren.
5. Als Arbeitsergebnis eine konsistente Dokumentvorlage versionieren und für wiederholte Generierungen bereitstellen.

4. Generierung nach DOCX, ODT und PDF

Schwerpunkt: Ausgabeparameter, Dateinamen, Zielordner, Formatbesonderheiten und Wiederholbarkeit.

1. Adressaten, Informationsbedarf und Qualitätskriterien für den Themenblock „Generierung nach DOCX, ODT und PDF“ festlegen.
2. Folgende Dokumentelemente und Modellbezüge werden strukturiert: Ausgabeparameter, Dateinamen, Zielordner, Formatbesonderheiten und Wiederholbarkeit.
3. Vorlagen, Abfragen und Generierungsschritte schrittweise konfigurieren und ausführen.
4. Vollständigkeit, Aktualität, Layout, Querverweise und Wiederholbarkeit anhand eines Prüfkatalogs kontrollieren.
5. Als Arbeitsergebnis einen reproduzierbaren Mehrformat-Generierungslauf versionieren und für wiederholte Generierungen bereitstellen.

5. Qualitätsprüfung und Automatisierung

Schwerpunkt: Vollständigkeit, veraltete Inhalte, Layout, Fehlerprotokolle, Versionierung und Buildintegration.

1. Serviceziele, Verantwortlichkeiten und Kontrollpunkte für den Themenblock „Qualitätsprüfung und Automatisierung“ definieren.
2. Folgende Betriebsobjekte und Abhängigkeiten werden erfasst und priorisiert: Vollständigkeit, veraltete Inhalte, Layout, Fehlerprotokolle, Versionierung und Buildintegration.
3. Kontrollen, Runbooks oder Betriebsabläufe in der Laborumgebung beziehungsweise am Prozessmodell umsetzen.
4. Regelbetrieb, Störung, Wiederanlauf und Nachkontrolle mit festgelegten Szenarien prüfen.
5. Als Arbeitsergebnis eine Abnahmecheckliste und einen automatisierbaren Generierungsprozess freigeben und in einen wiederholbaren Arbeits- oder Betriebsstandard übernehmen.

Praxisübungen und Laborszenarien

• Aufbau eines Dokumentmodells für ein vorhandenes UML-Beispiel.
• Einbindung von Modelltexten, Diagrammen und Tabellen in eine Vorlage.
• Erzeugung und Qualitätsvergleich mehrerer Ausgabeformate.

Zielgruppe und Voraussetzungen

Zielgruppe: Technische Redaktion, Software- und Systemarchitektur, Qualitätsmanagement, Modellierungsverantwortliche und Dokumentationsautomation.

Voraussetzungen: Grundkenntnisse in Eclipse Papyrus und Erfahrung mit strukturierten technischen Dokumenten.

Didaktik und Arbeitsweise

Kurze Fachimpulse wechseln mit geführten Modellierungsschritten und einer zusammenhängenden Praxisaufgabe. Jeder Arbeitsschritt besitzt definierte Ausgangswerte, Prüfpunkte und ein dokumentiertes Ergebnis.