Dobre praktyki dokumentacji parametrów konfiguracyjnych
Czytelne nazwy kluczy
Nazwy parametrów powinny jasno wskazywać na ich przeznaczenie i kontekst użycia.
Opisy parametrów
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.
W komentarzu można również uwzględnić historię zmian parametru.
Zróżnicowanie parametrów ze względu na środowiska
Parametry mogą być różnicowane dla środowisk (np. nazwaParametru
Parametry wdrożeniowe a biznesowe
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.
Uprawnienia do edycji w Eximee Dashboard
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).
Ostatnia aktualizacja
Czy to było pomocne?