To document a model or a source from the repository tree...
- Select an existing model version and select REPLACE WITH THIS IMAGE: Images/Common_Icons/doco.png Document model from the Workflow pane.
- From the Generate documentation dialog, select the Document a model or Document a source radio button as the purpose of the generation.
Note
Depending on your selection, some screens may differ.
HTML
- To create an HTML web page, choose HTML web page. Click Next to continue.
REPLACE WITH THIS IMAGE: Images/Documentation/generatedoc_HTML_model.png
- Select the models to document and click Next to continue.
REPLACE WITH THIS IMAGE: Images/Documentation/generatedocs-choosemodel.png
- Enter the title and select the items to be included in the documentation generation. Click Next to continue.
REPLACE WITH THIS IMAGE: Images/Documentation/generatedocs_settings_model.png
- The location where the document will be saved will differ according to your user name. Click Generate.
REPLACE WITH THIS IMAGE: Images/Documentation/generatedocs_chooseoutput_model.png
- Select the Business semantics.
REPLACE WITH THIS IMAGE: Images/Documentation/generatedocs_busssemantics.png
- Select the Entity metrics.
REPLACE WITH THIS IMAGE: Images/Documentation/generatedocs_entitymetrics.png
- Select the Attribute metrics.
REPLACE WITH THIS IMAGE: Images/Documentation/generatedocs_attributemetrics.png
- Select the Relationship metrics.
REPLACE WITH THIS IMAGE: Images/Documentation/generatedocs_relationshipmetrics.png
- Click Generate.
Note
The settings for documentation generation are remembered.
Word
- To create an HTML web page, choose Word document. Click Next to continue.
REPLACE WITH THIS IMAGE: Images/Documentation/generatedocs_word_model.png
- Select the models to document and click Next to continue.
REPLACE WITH THIS IMAGE: Images/Documentation/generatedocs-choosemodel.png
- Enter the title and select the items to be included in the documentation generation. Click Next to continue.
REPLACE WITH THIS IMAGE: Images/Documentation/generatedocs_word_settings_model.png
Note |
---|
Indexes are not generated in the documentation by default, but they can be included when desired. |
- The location where the document will be saved will differ according to your user name.
REPLACE WITH THIS IMAGE: Images/Documentation/generatedocs_chooseoutput_model.png
- Select the Business semantics.
REPLACE WITH THIS IMAGE: Images/Documentation/generatedocs_busssemantics.png
- Select the Entity metrics.
REPLACE WITH THIS IMAGE: Images/Documentation/generatedocs_entitymetrics.png
- Select the Attribute metrics.
REPLACE WITH THIS IMAGE: Images/Documentation/generatedocs_attributemetrics.png
- Select the Relationship metrics.
REPLACE WITH THIS IMAGE: Images/Documentation/generatedocs_relationshipmetrics.png
- Select the Effort calculations.
REPLACE WITH THIS IMAGE: Images/Documentation/generatedocs_effortcalculations.png
- Click Generate.
Note
The settings for documentation generation are remembered.