Content Types (Diátaxis Model)
This document outlines the four documentation content types and their execution criteria.1. Tutorials (Learning-oriented)
- Goal: Help a newcomer achieve a concrete “first win” without distraction.
- Tone: Encouraging, linear, minimal branching.
- Rule: Do not attempt to cover edge cases or exhaustively describe all parameters.
2. How-To Guides (Problem-oriented)
- Goal: Guide a practitioner through solving a specific, real-world task.
- Tone: Direct, actionable, sequenced steps.
- Rule: Assume the user understands basic platform concepts. Avoid conceptual lectures.
3. Reference (Information-oriented)
- Goal: Provide accurate, searchable, complete specifications.
- Tone: Neutral, rigorous, tabular.
- Rule: Consistent table columns (
Parameter,Type,Required,Default,Description).
4. Explanation (Understanding-oriented)
- Goal: Clarify the “why”, the architecture, the mental model, and design trade-offs.
- Tone: Thoughtful, lucid, objective.
- Rule: Do not hide trade-offs or operational bottlenecks. Use diagrams where beneficial.