Assistent zur Dokumentationsgenerierung

Der Assistent zur Dokumentationsgenerierung führt Sie schrittweise durch den Vorgang zum Erzeugen einer Dokumentation eines Innovator-Modells.

Zweck

Der Assistent zur Dokumentationsgenerierung führt Sie schrittweise durch die für die Generierung notwendigen Arbeitsschritte, in denen Umfang und Aufbau der Dokumentation festgelegt werden.

Aufruf

Klicken Sie in der Backstage-Ansicht Dokumentation erstellen & senden auf eine der Schaltflächen:

  • Als Word-Dokument
  • Als XML/HTML
  • Vorschau
  • Doku-Assistent

Schritt 1 von 4: Inhalte der Dokumentation auswählen

Sie können Dokumentationen erzeugen, die alle oder einen Teil der Informationen aus einem Modell zu einem bestimmten Entwicklungsstand enthalten. Dieser Assistent führt Sie schrittweise durch den Vorgang zum Erzeugen einer Dokumentation.

Sie können als initialen Inhalt der Dokumentation auswählen:

Initial ist der Inhalt insofern, dass im anschließend auszuwählenden Dokumentationskommando eine Suche zur Selektionsbestimmung konfiguriert werden kann.

Schritt 2 von 4: Dokumentationskommando auswählen

Die Einstellungen für Kapitelstruktur, Ausgabeformat, Kopf-und Fußzeilen usw., die bei der Dokumentationsgenerierung zu verwenden sind, sind als Dokumentationskommandos in der Konfiguration Ihres Modells hinterlegt worden. In diesem Schritt werden Sie dazu aufgefordert, sich für eins davon zu entscheiden.

Die Standard-Dokumentationskommandos sind zur Selektionserweiterung mit der Suche Paketinhalt mit Unterpaketen verbunden, liefern standardmäßig also jeweils rekursiv den Paketinhalt selektierter Modellelemente. Die Suche ist in der Datei $INODIR/inoref gespeichert.

Schritt 4 von 4: Bereit für Dokumentationsgenerierung

Bevor die eigentliche Dokumentationsgenerierung beginnt, zeigt Ihnen der Assistent zur Dokumentationsgenerierung eine Zusammenfassung der von Ihnen getroffenen Entscheidungen.

Sie können diese Entscheidungen noch einmal korrigieren, indem Sie mit der Zurück-Schaltfläche zu einem der vorherigen Schritte zurückkehren.

Um die Generierung auszulösen, klicken Sie auf die Schaltfläche Fertigstellen.