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

  1. Select an existing model version and select  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.

Depending on your selection, may differ.

HTML

  1. To create an HTML web page, choose HTML web page. Click Next to continue.
  2. Select the models to document and click Next to continue.
  3. Enter the title and select the items to be included in the documentation generation. Click Next to continue.
  4. The location where the document will be saved will differ according to your user name. Click Generate.
  5. Select the Business semantics.
  6. Select the Entity metrics.
  7. Select the Attribute metrics.
  8. Select the Relationship metrics.
  9. Click Generate.

The settings for documentation generation are remembered.

Word

  1. To create an HTML web page, choose Word document. Click Next to continue.
  2. Select the models to document and click Next to continue.
  3. Enter the title and select the items to be included in the documentation generation. Click Next to continue.

     Indexes are not generated in the documentation by default, but they can be included when desired.

  4. The location where the document will be saved will differ according to your user name.
  5. Select the Business semantics.
  6. Select the Entity metrics.
  7. Select the Attribute metrics.
  8. Select the Relationship metrics.
  9. Select the Effort calculations.
  10. Click Generate.

The settings for documentation generation are remembered.