Skip to main content

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
  • Version
  • Author

Right-click in the process name area and select Properties.

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

Documenting Process Level

We recommend including extended information such as:

  • Scope
  • Goal
  • Process owner
  • Important definitions
  • Annexes

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:

  • Name of the element
  • A complete description
  • Resources (only for Activities)

Steps to Document an Element​

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

    Documenting Elements Step 1

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

    Documenting Elements Step 2

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

We also advise including supplementary information for Activities and Intermediate Events, such as:

  • Duration
  • Business rules that resources must comply with
  • Any documentation or forms that are used