# Dobre praktyki dokumentacji parametrów konfiguracyjnych

| Obszar                                            | Reguła                                                                                                                                                                                                                                                                               |
| ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Czytelne nazwy kluczy                             | <ul><li>Nazwy parametrów powinny jasno wskazywać na ich przeznaczenie i kontekst użycia.</li></ul>                                                                                                                                                                                   |
| Opisy parametrów                                  | <ul><li>W konfiguracji należy dodawać komentarze (poprzedzone znakiem #), które wyjaśniają znaczenie i zastosowanie danego parametru, wartości domyślne, zakresy czy wpływ na działanie aplikacji.</li><li>W komentarzu można również uwzględnić historię zmian parametru.</li></ul> |
| Zróżnicowanie parametrów ze względu na środowiska | <ul><li>Parametry mogą być różnicowane dla środowisk (np. nazwaParametru</li></ul>                                                                                                                                                                                                   |
| Parametry wdrożeniowe a biznesowe                 | <ul><li>Należy rozdzielać parametry wdrożeniowe od biznesowych. Parametry techniczne np. adresy usług powinny być przechowywane w konfiguracji wdrożeniowej, natomiast biznesowe (np. limity, flagi funkcjonalności) w konfiguracji low code.</li></ul>                              |
| Uprawnienia do edycji w Eximee Dashboard          | <ul><li>Należy dokumentować, czy parametry mają możliwość edycji w Eximee Dashboard i kto je może edytować (np. grupa osób z rolą feature\_config\_edit).</li></ul>                                                                                                                  |