Process Documentation

Process Documentation provides a comprehensive overview of a process showing the process map and a description of all steps in it. Entered documentation is for informational purposes only and does not affect the functionality of the process.

Process documentation has the following attributes:

• The name of the Process.

• When the Process was last updated and by whom.

• A description of the Process as entered when creating a new process.

• An image of the Process map.

• Names of all steps in the process and their unique node IDs.

• The documented description of each modeling object.

Here is an example of a documented Process.

What's new in the Winter 2025 release?

• Move between parent and subprocesses without the hassle of manually searching for related documentation.

• Download process documentation in PDF format, making it easier to share and store documents.

• Configure user permissions to allow view-only or edit access to documentation.

Watch the following product tour to learn how to quickly generate process documentation.

View Process Documentation

Follow these steps to view documentation for a Process:

1. View your Processes.

2. Click the ellipses menu, and then select the View Documentation option to view the documentation for that process.

   

3. Click the PDF button to download documentation in a standardized PDF format for easy sharing and storage. All node IDs in the process map are included in the PDF to help relate each object in the map to its corresponding description.

4. Click the Document with AI button to document the process.

Navigate Between Parent and Subprocesses

Navigate between parent processes and subprocesses through embedded links, streamlining the process of reviewing related documentation.

Follow these steps to view documentation for subprocesses:

1. View your Processes.

2. Click the ellipses menu, and then select the View Documentation option to view the documentation for that process.

3. Find subprocesses (if any) in the documentation for the parent process.
   

4. Click the subprocesses to view the link to their associated documentation.
   

5. Click on the link Open subprocess in new window to access the process.

Document with AI

Documentation for a process can be generated in the following ways:

• Enter the documentation in the configuration for each object in the Modeler. See an example of adding documentation for a Subprocess.

• Use AI to create documentation for all modeling objects at once.

Watch the following product tour to learn how to create process documentation using AI.

Follow these steps to generate process documentation using AI:

1. View documentation for a process.

2. Click the Document with AI button .

   

3. Choose the Generate from Scratch option to replace all current documentation and create new documentation for each object.

4. Alternatively, select the Use Current Documentation option to retain any existing documentation and only generate new one for objects without any documentation.

5. Process documentation will be generated based on the selected option, displaying the current and suggested object documentations next to each other.

   

6. Use the check box next to each object to accept or skip the suggested documentation.

   • When using the Generate from Scratch option, all checkboxes are selected by default.

   • When using the Use Current Documentation option, all checkboxes are unchecked, allowing the designer to select which ones to use.

7. Click Apply Changes to save the changes. Otherwise, click Cancel.

8. To regenerate the documentation for a process, repeat steps 1 through 7.

9. After the documentation is ready, blue circles on the process map act as hotspots. Hovering over the hotspots will display the description of that object.