Documenting each element

<< Click to Display Table of Contents >>

Navigation:  Documenting a process >

Documenting each element

Document at process level

The information included at process level describes the overall process.

By default you can include the following information: Name of the process, description, the version and the author.

 

Right-click outside of the boundaries of the pool and select Diagram Properties.

This will enable the Diagram properties add-on window at the bottom of the screen, where you can include the relevant information.

 

 

Documenting6

 

 

We recommend to include extended information such as the scope, goal, process owner, important definitions and any annex. To learn how to include additional information please refer to Extending your documentation.

 

Such information may be included with rich-text formatting.

To learn more about this option, refer to Using rich-text formatting.

 

Document activities and elements

The information included in each element gives you the possibility to enter detailed information about each step of your flow.

By default you can include the Name of the element and a complete description. In Activities you can also include Resources.

 

1. Right-click on the element you wish to document and select Properties from the display menu.

 

Documenting1

 

 

2. This will enable the Element properties add-on window at the bottom of the screen, where you can include the relevant information.

 

Documenting2

 

Insert all relevant information focusing on being as clear, thorough and informative as possible. This is essential to ensure the document is readable and the process easily understood for successful execution.

We also advise to include the supplementary information for Activities and Intermediate Events, such as duration, business rules that resources must comply with and any documentation or forms that are used.

 

If you are automating your process we recommend to include the forms that will be displayed to performers.

To learn how to include additional information please refer to Extending your documentation.

To learn more about process automation please refer to Process Execution.