Verwenden des Dokumentationsassistenten

Die Dokumentation des Modells oder eines Modellausschnitts erstellen Sie mit dem Dokumentationsassistenten.

Voraussetzungen

Sie sind in einem Modell angemeldet.

Mindestens ein Dokumentationskommando ist konfiguriert.

Die Benutzerrolle muss Ausführungsrechte auf das Dokumentationskommando besitzen.

Zusammenhang

Sie erstellen mit Hilfe des Dokumentationsassistenten eine Dokumentation mit dem aktuellen Entwicklungsstand des gesamten Modells oder eines Modellausschnitts.

Ausgabeformat, Struktur und Layout der Dokumentation werden im Konfigurationseditor über die Eigenschaften des Dokumentationskommandos festgelegt. Der Inhalt ergibt sich durch die Schnittmenge der Selektion im Modell und der konfigurierten Dokumentationsstruktur.

So gehen Sie vor

Öffnen Sie das Register Modell.
Wählen Sie auf dem Register Dokumentation erstellen & senden je nach gewünschtem Ausgabeformat einen der Befehle Microsoft Office Word-Dokument, XML-Datei / HTML-Seiten oder Dokumentvorschau.
Falls Sie noch nicht wissen, welches Ausgabeformat für Sie geeignet ist, wählen sie den Befehl Dokumentationsassistenten verwenden.

Das Fenster mit dem Dokumentationsassistenten erscheint.
Wählen Sie den Inhalt der Dokumentation aus.
Sie müssen sich dabei zwischen der Dokumentation der aktuellen Selektion, eines individuellen Ausschnitts des Modells oder des gesamten Modells entscheiden.
Wenn Sie Dokumentenfenster geöffnet haben, dann können Sie sich auch für die Dokumentation des aktiven Dokuments oder aller geöffneten Dokumente entscheiden.
Wenn Sie sich entschieden haben, einen individuellen Ausschnitt des Modells zu dokumentieren, dann müssen Sie im nächsten Schritt die gewünschten Elemente in eine Auswahlliste übernehmen.
Wenn mehrere Dokumentationskommandos konfiguriert sind, dann wählen Sie das Dokumentationskommando aus, das Sie benutzen möchten, um Ihre Dokumentation zu erstellen.
Wenn Sie die Einstellungen für die Dokumentationsgenerierung ändern wollen, dann klicken Sie links oben auf den Zurück-Pfeil.

Der Assistent bringt Sie zu den bisherigen Schritten zurück. Ändern Sie Ihre Einstellungen.
Überprüfen Sie, ob Sie Ihre Entscheidungen korrekt getroffen haben, und bestätigen Sie mit Fertigstellen.

Die Dokumentationsgenerierung beginnt.

Das erstellte Dokument öffnet sich, falls die Konfiguration des Dokumentationskommandos dem nicht widerspricht.
Wenn Sie die generierte Dokumentation öffnen wollen, dann bestätigen Sie die Abfrage mit Ja.

Die generierte Dokumentation wird in Microsoft Word oder im HTML-Browser geöffnet.
Das Word-Dokument können Sie drucken, als PDF speichern oder als Anhang einer E-Mail versenden.
Die HTML-Seiten können Sie im Browser betrachten usw. Im Verzeichnis der HTML-Seiten finden Sie auch die XML-Datei, aus der die HTML-Seiten generiert wurden.
Um das zuletzt verwendete Dokumentationskommando zu benutzen und zur aktuellen Selektion eine Dokumentation zu erzeugen, wählen Sie Modell>Dokumentation erstellen & senden>Erneut generieren.