Documentation practice
We develop best practice for documentation through good examples – not by locking ourselves into a rigid template from the start. This page collects experiences and patterns as they emerge.
Approach
The structure of a documentation page should reflect the type of content. For decision documentation (such as roadmap items) we have drawn inspiration from the ADR format (Architecture Decision Records), adapted to our needs.
First example of this pattern: Add sub-chapter – option in the Edit menu.
Emerging pattern: decision documentation
Used for roadmap items and other choices where it is useful to document why, not just what.
| Section | Content |
|---|---|
| Background | The need to be addressed – short and concrete |
| Chosen solution | What we have decided, including remaining work |
| Alternatives considered | Other solutions that were evaluated, without assessment |
| Rationale | Why the chosen solution was preferred over the alternatives |
This is not a binding template – it is a starting point. Adjust the structure where the content requires it, and update this page as the pattern evolves.