Diataxis Framework

The Diátaxis framework is a structured approach to organizing documentation, designed to make it easier for users to find the information they need based on their goals and the specific context in which they’re using a product. Diátaxis was created to address the common problem of documentation overload by categorizing content into clear, user-focused sections, each tailored to a specific purpose. At Katara, we use the Diátaxis framework as the basis for our . This workflow helps you align with the Diátaxis framework by analyzing your existing documentation and generating new content.

The Four Quadrants of Diátaxis

Diátaxis divides documentation into four main types, each serving a unique purpose:

Tutorials – Learning by Doing Tutorials guide users through practical steps to achieve specific outcomes. They’re hands-on and goal-oriented, teaching users by walking them through a task or process. Tutorials are ideal for beginners or users looking to understand how to accomplish something concrete.
How-To Guides – Focused Problem Solving These are short, task-specific guides that provide steps for accomplishing specific tasks or solving problems. How-To guides are helpful for users who have some familiarity with the product and need specific solutions quickly. These guides focus on “how” to do something efficiently without going into extensive theory.
Reference – In-Depth Information Reference materials are comprehensive and cover the product’s features and functionalities in detail. They act as the go-to resource for precise information, including technical details, API endpoints, and configurations. Unlike tutorials or guides, reference documentation is not task-based; it’s structured for users to look up specific information as needed.
Explanations – Deep Dives into Concepts Explanations clarify the “why” behind features, design choices, or approaches. They provide context and background information, helping users understand the underlying concepts and rationale. Explanations are particularly useful for users who want to grasp the big picture or make more informed decisions about using the product.

PreviousRAGs - Extending AI context NextAgents and Workflows

Last updated 1 day ago

The Four Quadrants of Diátaxis

Diátaxis divides documentation into four main types, each serving a unique purpose:

Tutorials – Learning by Doing Tutorials guide users through practical steps to achieve specific outcomes. They’re hands-on and goal-oriented, teaching users by walking them through a task or process. Tutorials are ideal for beginners or users looking to understand how to accomplish something concrete.
How-To Guides – Focused Problem Solving These are short, task-specific guides that provide steps for accomplishing specific tasks or solving problems. How-To guides are helpful for users who have some familiarity with the product and need specific solutions quickly. These guides focus on “how” to do something efficiently without going into extensive theory.
Reference – In-Depth Information Reference materials are comprehensive and cover the product’s features and functionalities in detail. They act as the go-to resource for precise information, including technical details, API endpoints, and configurations. Unlike tutorials or guides, reference documentation is not task-based; it’s structured for users to look up specific information as needed.
Explanations – Deep Dives into Concepts Explanations clarify the “why” behind features, design choices, or approaches. They provide context and background information, helping users understand the underlying concepts and rationale. Explanations are particularly useful for users who want to grasp the big picture or make more informed decisions about using the product.