To document a model or a source from the repository tree...

1. Select an existing model version and select REPLACE WITH THIS IMAGE: Images/Common_Icons/doco.png Document model from the Workflow pane.
2. 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

1. To create an HTML web page, choose HTML web page. Click Next to continue.

REPLACE WITH THIS IMAGE: Images/Documentation/generatedoc_HTML_model.png

1. Select the models to document and click Next to continue.

REPLACE WITH THIS IMAGE: Images/Documentation/generatedocs-choosemodel.png

1. 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

1. 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

1. Select the Business semantics.

REPLACE WITH THIS IMAGE: Images/Documentation/generatedocs_busssemantics.png

1. Select the Entity metrics.

REPLACE WITH THIS IMAGE: Images/Documentation/generatedocs_entitymetrics.png

1. Select the Attribute metrics.

REPLACE WITH THIS IMAGE: Images/Documentation/generatedocs_attributemetrics.png

1. Select the Relationship metrics.

REPLACE WITH THIS IMAGE: Images/Documentation/generatedocs_relationshipmetrics.png

1. Click Generate.

   Note
   The settings for documentation generation are remembered.

Word

1. To create an HTML web page, choose Word document. Click Next to continue.

REPLACE WITH THIS IMAGE: Images/Documentation/generatedocs_word_model.png

1. Select the models to document and click Next to continue.

REPLACE WITH THIS IMAGE: Images/Documentation/generatedocs-choosemodel.png

1. 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

1. 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

1. Select the Business semantics.

REPLACE WITH THIS IMAGE: Images/Documentation/generatedocs_busssemantics.png

1. Select the Entity metrics.

REPLACE WITH THIS IMAGE: Images/Documentation/generatedocs_entitymetrics.png

1. Select the Attribute metrics.

REPLACE WITH THIS IMAGE: Images/Documentation/generatedocs_attributemetrics.png

1. Select the Relationship metrics.

REPLACE WITH THIS IMAGE: Images/Documentation/generatedocs_relationshipmetrics.png

1. Select the Effort calculations.

REPLACE WITH THIS IMAGE: Images/Documentation/generatedocs_effortcalculations.png

1. Click Generate.

   Note
   The settings for documentation generation are remembered.