Best practices

Rule
Rule description

Language

If there are no overarching agreements on the names of tasks, subprocesses, events and gateways, use Polish. Name variables according to the convention adopted in the given application (in Polish or English).

Letter case

Start names with a capital letter, and write subsequent words with a lowercase letter (e.g. "Document checking"). Exceptions are proper names and acronyms. Lack of consistency (e.g. lowercase used sometimes and uppercase other times) will make it harder to quickly recognize process elements.

Avoiding technical terms

Instead of using classes or methods from code, use language understandable by the business. Unclear or too technical names may be misleading, for example, instead of "Verify documents" using "ExecuteDocumentCheck" makes the process harder to understand for non-technical people.

Consistency of verbs in activity names

Use a consistent verb form in activity names in the process. For example, choose between infinitives ("Approve documents") and gerund forms ("Approving documents") and apply them consistently throughout the model.

Precision and unambiguity

Make sure the name accurately reflects the part of the process in the business context. Avoid ambiguous names that may be interpreted differently by different people. For example, instead of "Handling a request" it is better to use "Recording a transaction complaint".

  • Description of gateway conditions

Use unambiguous gateway labels, e.g. "Yes" / "No". Avoid long, unnecessary descriptions and the use of technical terms such as "True" / "False".

  • Description of start and end events

If possible, for start and end elements of the process use names more precise than "Start" and "End" (they do not indicate the circumstances of the process start or end).

Version numbering of process steps

If a process has steps with similar names, add version or step numbering, e.g. "Document verification 1" and "Document verification 2", to avoid confusion. However, try to avoid such names when possible (see rule above).

Avoiding abbreviations

Avoid abbreviations e.g. Instead of using the abbreviation "Approv. contract" it is better to write the full form "Contract approval".

Status names

If possible, use a single standard for status names (businessStatus) that takes the business context into account.

More information: https://blog.consdata.tech/2025/01/27/wstep-do-tworzenia-czytelnych-modeli-bpmn.html

Last updated

Was this helpful?