Best practices for documenting configuration parameters
Readable key names
Parameter names should clearly indicate their purpose and context of use.
Parameter descriptions
In the configuration, comments should be added (preceded by the # sign) that explain the meaning and use of a given parameter, default values, ranges, or the impact on the application's operation.
The comment can also include the history of changes to the parameter.
Differentiation of parameters by environment
Parameters can be differentiated for environments (e.g. parameterName
Deployment parameters vs. business parameters
Deployment parameters should be separated from business parameters. Technical parameters, e.g. service addresses, should be stored in deployment configuration, while business parameters (e.g. limits, feature flags) in low-code configuration.
Editing permissions in Eximee Dashboard
It should be documented whether parameters can be edited in Eximee Dashboard and who can edit them (e.g. a group of people with the feature_config_edit role).
Last updated
Was this helpful?
