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.
Aufbau
Oben wird angezeigt, welchen Schritt Sie gerade bearbeiten, und ab dem zweiten Schritt befindet sich dort eine Zurück-Schaltfläche 
, mit der Sie zum vorherigen Schritt zurückkehren können.
Mittig werden die Eingabe- und Auswahlmöglichkeiten angeboten, ggf. führt eine Auswahl direkt zum nächsten Schritt.
Unten befinden sich die Schaltflächen Weiter (sofern nicht die Auswahl zum nächsten Schritt führt) oder Fertigstellen und stets die Schaltfläche Abbrechen.
Schritt 1 von 3: 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:
- Das aktive Dokument (Diagramm, Tabelle oder Spezifikation)
- Alle geöffneten Dokumente des Arbeitsbereichs
- Die aktuelle Selektion
- Ein individueller Ausschnitt des Modells (Selektion im Dialog Assistent zur Dokumentationsgenerierung)
- Das gesamte Modell
Initial ist der Inhalt insofern, dass im anschließend auszuwählenden Dokumentationskommando eine Suche zur Selektionsbestimmung konfiguriert werden kann.
Das aktive Dokument dokumentieren
In die Dokumentation wird initial nur das aktive Dokument aufgenommen, d.h. das im Dokumentenbereich der Anwendung aktuell sichtbare Diagramm bzw. die sichtbare Tabelle.
Der Name des aktiven Dokuments wird im Assistenten angezeigt.
Alle geöffneten Dokumente des Arbeitsbereichs dokumentieren
In die Dokumentation werden initial alle im Dokumentenbereich der Anwendung aktuell geöffneten Diagramme und Tabellen aufgenommen.
Die Anzahl der aktiven Dokumente wird im Assistenten angezeigt.
Die aktuelle Selektion dokumentieren
In die Dokumentation werden initial nur die Modellelemente aufgenommen, die beim Aufruf des Dokumentationsassistenten im aktiven Fenster der Anwendung selektiert waren.
Wenn Sie ein Modellelement selektiert haben, dann wird dessen Name im Assistenten angezeigt, bei mehreren Modellelementen deren Anzahl.
Einen individuellen Ausschnitt des Modells dokumentieren
In die Dokumentation werden initial die Modellelemente aufgenommen, die Sie im nächsten Schritt unabhängig von der aktuellen Selektion durch Aktivieren der entsprechenden Auswahlfelder bestimmen. Die Selektion im aktiven Fenster der Anwendung wird ignoriert.
Das gesamte Modell dokumentieren
In die Dokumentation werden initial alle Modellelemente des Modells aufgenommen.
Schritt 2 von 3: 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 3 von 3: 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.
Verwandte Themen