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.
.png)
Documentation for a Process
What's new?
Introduced in the Summer 2024 release, you can now use AI to quickly generate effective process documentation saving time and effort. This ensures that all stakeholders have access to detailed process information, promoting better compliance and execution.
Generate process documentation with one click.
Create documentation from scratch or enhance current documentation.
View Process Documentation
Permissions
Your user account or group membership must have the following permissions to view documentation for a Process unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
See the Processes permissions or ask your Administrator for assistance.
Follow these steps to view documentation for a Process:
Click the ellipses
.png "image(142).png")
menu, and then select the View Documentation option to view the documentation for that process.
Document with AI
Documentation for a process can be added in the following ways:
Enter the documentation in the configuration for each object in the Modeler. See an example of adding documentation for a Sub-Process.
Use AI to create documentation for all modeling objects in one place.
Watch the following product tour to learn how to create process documentation using AI.
Follow these steps to generate process documentation using AI:
Click the Document with AI button
.png "image(141).png")
. .png "image(140).png")
Choose the Generate from Scratch option to replace all current documentation and create new documentation for each object.
Alternatively, select the Use Current Documentation option to retain any existing documentation and only generate new one for objects without any documentation.
Process documentation will be generated based on the selected option, displaying the current and suggested object documentations next to each other.
.avif "image(5).avif")
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.
Click Apply Changes to save the changes. Otherwise, click Cancel.
To regenerate the documentation for a process, repeat steps 1 through 7.
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.
