Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Select an existing model version and select REPLACE WITH THIS IMAGE: Images/Common_Icons/doco.png Document Image Added 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
titleNote

Depending on your selection,

...

may differ.

HTML

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

The settings for documentation generation are remembered.

Word

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

     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.
    Image Added
  5. Select the Business semantics.
    Image Added
  6. Select the Entity metrics.
    Image Added
  7. Select the Attribute metrics.
    Image Added
  8. Select the Relationship metrics.
    Image Added
  9. Select the Effort calculations.
    Image Added
  10. Click Generate.
Note
titleNote

The settings for documentation generation are remembered.