# Dobre praktyki

| Reguła                                                    | Opis reguły                                                                                                                                                                                                                                                                                                         |
| --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Język                                                     | <p>W przypadku braku odgórnych ustaleń w nazwach zadań, podprocesów, zdarzeń i w bramkach stosujemy język polski.<br>Zmienne nazywaj zgodnie z przyjętą konwencją w danej aplikacji (w języku polskim lub angielskim).</p>                                                                                          |
| Wielkość liter                                            | <p>Zaczynaj nazwy od wielkiej litery, a kolejne wyrazy pisz małą literą (np. <em>"Sprawdzanie dokumentów"</em>).<br>Wyjątki stanowią nazwy własne i akronimy. Brak konsekwencji (np. raz użycie małych liter, a innym razem dużych) utrudni szybkie rozpoznanie elementów procesu.</p>                              |
| Unikanie terminów technicznych                            | <p>Zamiast używać klas czy metod z kodu, stosuj język zrozumiały dla biznesu.<br>Niejasne lub zbyt techniczne nazwy mogą wprowadzić w błąd, np. zamiast <em>„Weryfikuj dokumenty”</em> użycie <em>„ExecuteDocumentCheck”</em> sprawia, że proces staje się trudniejszy do zrozumienia dla osób nietechnicznych.</p> |
| Spójność czasowników w nazwach czynności                  | Używaj jednolitej formy czasowników w nazwach czynności w procesie. Na przykład, wybierz pomiędzy bezokolicznikami ("Zatwierdzić dokumenty") a formami osobowymi ("Zatwierdzanie dokumentów") i stosuj je konsekwentnie w całym modelu.                                                                             |
| Precyzjność i jednoznaczność                              | Upewnij się, że nazwa dokładnie odzwierciedla daną część procesu w kontekście biznesowym. Unikaj wieloznacznych nazw, które mogą być różnie interpretowane przez różne osoby. Na przykład, zamiast „*Obsługa zgłoszenia*” lepiej użyć „*Rejestracja reklamacji transakcji*”.                                        |
| <ul><li>Opis warunków bramek</li></ul>                    | Stosuj jednoznaczne opisy bramek, np. *"Tak"* / *"Nie"*. Unikaj długich, zbędnych opisów oraz używania terminów technicznych, takich jak *"True"* / *"False"*.                                                                                                                                                      |
| <ul><li>Opis zdarzenia początkowego i końcowego</li></ul> | Jeśli to możliwe, dla początkowych i końcowych elementów procesu używaj bardziej precyzyjnych nazw niż *"Start"* i *"Koniec"* (nie wskazują one okoliczności rozpoczęcia lub zakończenia procesu).                                                                                                                  |
| Numeracja wersji kroków procesów                          | Jeśli w procesie występują kroki o zbliżonych nazwach, dodawaj numerację wersji lub kroków, np. „*Weryfikacja dokumentów 1*” i „*Weryfikacja dokumentów 2*”, aby uniknąć pomyłek. Staraj się jednak w miarę możliwości unikać takich nazw (patrz reguła wyżej).                                                     |
| Unikanie skrótów                                          | Unikaj skrótów np. Zamiast używać skrótu "*Zatw. umowy*", lepiej napisać pełną formę "*Zatwierdzenie umowy*".                                                                                                                                                                                                       |
| Nazwy statusów                                            | Jeśli to możliwe, stosuj jeden standard nazw statusów (businessStatus) uwzględniający kontekst biznesowy.                                                                                                                                                                                                           |

Więcej informacji: <https://blog.consdata.tech/2025/01/27/wstep-do-tworzenia-czytelnych-modeli-bpmn.html>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.eximee.com/budowanie-aplikacji/proces-biznesowy/tworzenie-procesu-biznesowego-w-bpmn-2.0/dobre-praktyki.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.