Creating Documentation

Learn how to create documentation.

To generate documentation for a template:

  1. Select File > Create Documentation from the menu.
  2. Browse to the target directory and enter a file name for the documentation.
  3. Select which topics are to be included in the documentation. The following topics are available:
    • Processes: Outputs a breakdown of the contents of processes in the package with an overview of all items in the process grouped by type.
    • Appendix: Outputs information on the individual items in the package, grouped by type. The item overview includes the item's name, description, documents, hyperlinks, and a list of items that reference it.
    • Delta: Lists all formats that have been edited in this version (and therefore have a new version number that is the same as the package version number).
  4. Choose whether to include additional information in the appendix if you have included the appendix in the documentation. The following options are available:
    • History: Enable this option to include the history of each item in the appendix.
    • Referenced Items: Enable this option to include a list of all items references by an item in the appendix.
  5. Click on OK.
  6. The documentation is generated and opened in the associated application.