> For the complete documentation index, see [llms.txt](https://docs.eximee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.eximee.com/documentation/documentation-en/zarzadzanie-aplikacja-biznesowa/zarzadzanie-konfiguracja/konfiguracja-aplikacji-biznesowej-serwer-konfiguracji/dobre-praktyki-dokumentacji-parametrow-konfiguracyjnych.md).

# Best practices for documenting configuration parameters

| Area                                          | Rule                                                                                                                                                                                                                                                                                                 |
| --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Readable key names                            | <ul><li>Parameter names should clearly indicate their purpose and context of use.</li></ul>                                                                                                                                                                                                          |
| Parameter descriptions                        | <ul><li>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.</li><li>The comment can also include the history of changes to the parameter.</li></ul> |
| Differentiation of parameters by environment  | <ul><li>Parameters can be differentiated for environments (e.g. parameterName</li></ul>                                                                                                                                                                                                              |
| Deployment parameters vs. business parameters | <ul><li>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.</li></ul>                                  |
| Editing 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
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` 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>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.