Chapter 6. Generating Documentation

6.1. Generating Documentation

The Process Modeler can generate traditional looking documentation such as a process flow document, requirements list, or an ownership document. These document types are ideal for printing. The Process Modeler can also generate clickable, diagram-based websites which are very powerful. To generate documentation select the generation template you wish to use from the Generate menu.

If you have not recently saved changes to your project file, you may be prompted to save your changes before running the generator. Saving your unsaved changes before running a generator is optional.

6.2. Generation Preferences

To modify the documentation generation preferences select “Generation Preferences” from the Generate menu. This screen will allow you to do the following.

  • Specify an output location for generated documentation for each generator.

  • Specify if the Process Modeler should make a backup of previously generated documentation before running the selected generator.

  • Specify a backup folder in which to archive previously generated documentation.

  • Specify if you would like the backup folders to include an automatic timestamp as part of the backup folder name.

  • Modify write preferences for individual generated files.

Generation Preferences

Figure 6.1. Generation Preferences

File Write Preferences

Figure 6.2. File Write Preferences

6.3. Process Website

The process website is a fully clickable website that can be generated from your project. The website is split in to two panes. The top pane displays a diagram and the bottom pane displays information about the currently selected element. The elements in the diagram may be clicked on to change the information in the bottom pane. Diagram elements within a diagram may be double-clicked to drill down into the sub-diagram.

Process Website

Figure 6.3. Process Website