# 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>In the configuration, comments should be added (preceded by the # character) that explain the meaning and use of a given parameter, default values, ranges, or the impact on the application’s behavior.</li><li>The comment may also include the history of parameter changes.</li></ul> |
| Parameter differentiation by environment | <ul><li>Parameters can be differentiated for environments (e.g., parameterName</li></ul>                                                                                                                                                                                                          |
| Deployment and business parameters       | <ul><li>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.</li></ul>                                     |
| Edit permissions in Eximee Dashboard     | <ul><li>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).</li></ul>                                                                                                                |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.eximee.com/documentation/documentation-en/zarzadzanie-aplikacja-biznesowa/zarzadzanie-konfiguracja/konfiguracja-aplikacji-biznesowej-serwer-konfiguracji/dobre-praktyki-dokumentacji-parametrow-konfiguracyjnych.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.