Best practices

Rule
Rule description

Language

If there are no overriding conventions for task, subprocess, event and gateway names, use Polish. Name variables according to the convention adopted in the given application (in Polish or English).

Capitalization

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

Avoiding technical terms

Instead of using classes or methods from code, use language understandable to the business. Unclear or overly technical names can be misleading, e.g. 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 throughout the process. For example, choose between infinitives ("Approve documents") and gerunds/nominal forms ("Document approval") and use them consistently across the model.

Precision and unambiguity

Ensure the name accurately reflects the part of the process in the business context. Avoid ambiguous names that can be interpreted differently by different people. For example, instead of “Handling a report” it's better to use “Registration of transaction complaints”.

  • Description of gateway conditions

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

  • Description of start and end events

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

Version numbering of process steps

If the process contains steps with similar names, add version numbering or step numbers, e.g. “Document verification 1” and “Document verification 2” to avoid confusion. However, try to avoid such names where possible (see the rule above).

Avoiding abbreviations

Avoid abbreviations e.g. Instead of using the abbreviation "Aprv. contract" it's 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?