About this documentation
The structure of this documentation is based on the Diátaxis framework.
Diátaxis identifies four distinct needs, and four corresponding forms of documentation – tutorials, how-to guides, technical reference and explanation.
|
explanations understanding-oriented |
reference information-oriented |
theoretical knowledge |
|---|---|---|
|
tutorials learning-oriented |
how tos problem-oriented |
practical steps |
| useful when studying | useful when working |
Diátaxis solves problems related to documentation content (what to write), style (how to write it) and architecture (how to organise it).
see also
For a brief overview of this approach, see the article Improving Technical Documentation with the Diátaxis Framework.