# Best practices for documenting configuration parameters

| Area                                     | Rule                                                                                                                                                                                                                                                                              |
| ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Clear key names                          | <ul><li>Parameter names should clearly indicate their purpose and usage context.</li></ul>                                                                                                                                                                                        |
| Parameter descriptions                   | <ul><li>Comments should be added to the configuration (preceded by the # sign) to explain the meaning and use of a given parameter, default values, ranges, or impact on the application’s behavior.</li><li>The comment can also include the parameter change history.</li></ul> |
| Parameter differentiation by environment | <ul><li>Parameters may be differentiated for environments (e.g., parameterName</li></ul>                                                                                                                                                                                          |
| Deployment and business parameters       | <ul><li>Deployment parameters should be separated from business parameters. Technical parameters, e.g. service addresses, should be stored in the deployment configuration, while business parameters (e.g. limits, feature flags) in the low-code configuration.</li></ul>       |
| Edit permissions in Eximee Dashboard     | <ul><li>It should be documented whether the parameters can be edited in Eximee Dashboard and who can edit them (e.g. a group of people with the feature\_config\_edit role).</li></ul>                                                                                            |