Best practices for documenting configuration parameters

Area	Rule
Readable key names	Parameter names should clearly indicate their purpose and context of use.
Parameter descriptions	Configuration should include comments (preceded by #) that explain the meaning and application of a given parameter, default values, ranges, or impact on the application's behavior. The comment may also include the history of changes to the parameter.
Differentiation of parameters by environment	Parameters can be differentiated for environments (e.g. parameterName|test=parameterValueOnTest parameterName|prod=parameterValueOnProd). It is worth documenting which parameters are environment-specific and which are global.
Deployment parameters vs business parameters	Deployment parameters should be separated from business ones. Technical parameters, e.g. service addresses, should be stored in deployment configuration, while business parameters (e.g. limits, feature flags) in low-code configuration.
Edit permissions in Eximee Dashboard	You should document whether parameters can be edited in the Eximee Dashboard and who can edit them (e.g. a group of people with the feature_config_edit role).