Using Documentation Wizards

You can create documentation for a model or part of a model using the documentation wizard.

Prerequisites

You are logged-in to a model

At least one documentation command is configured.

The user roles needs to have execution rights for the documentation command.

Context

Create a documentation with the current development state of the entire model or a section of the model using the documentation wizard.

Documentation output format and layout are set in the configuration editor using the documentation command's properties. The contents is derived from the selection intersections in the model and the configured documentation structure.

How to proceed

Open the Model tab.
Depending on the output format you want, select one of the commands Microsoft Office Word Document, XML File / HTML Pages or Document Preview from the Create & Send Documentation tab
. Select the Use Documentation Wizard command if you do not know which output format you want yet.

The window with the documentation wizard appears.
Select the documentation contents.
You can choose between the documentation for the current selection, an individual section of the model or the entire model.
If you have document windows open, you can choose the documentation for the currently active document or for all open documents.
If you decide to document an individual section of the model, you need to add the elements you want from a drop-down list in the next step.
If multiple documentation commands are configured, select the documentation command which you want to use to create your documentation.
Click on the Back arrow at the top left if you want to change any options for documentation generation.

The wizard goes back a step. Change your settings.
Check whether you have made the correct selections and confirm with Finish.

Documentation generation starts.

The document created opens if the configuration of the documentation command does not conflict with it.
Confirm the query with Yes if you want to open the generated documentation.

The generated documentation is opened in Microsoft Word or in the HTML browser.
You can print the Word document, save it as a PDF or send it as an attachment in an e-mail.
You can view HTML pages in the browser. The HTML pages' directory also contains the XML file the HTML pages were generated from.
Select Model>Create & Send Documentation>Redo Generation to use the last used documentation command and create a documentation for the current selection.