Diataxis

All documentation pages must follow the Diataxis methodology, which is a way of organizing the documentation.

In Diataxis, all pages are of one of 4 types:

• Tutorials - learning-oriented experiences
• How-to guides - goal-oriented directions
• Reference - information-oriented technical description
• Explanation - understanding-oriented discussion

In addition, pages are segmented into three target audiences to make it easier for readers to find relevant content based on their usage profile:

• User
• Administrator
• Developer

Splitting pages by type and by audience means a reader looking for a quick procedure isn't forced to read background theory, and a reader looking for the "why" isn't buried in numbered steps. It also lets contributors reuse the same structure everywhere, since every page's location, title, and content follow the same rules regardless of the subject it documents.

Check how to apply diataxis for documentation.