diataxis

Structure technical documentation by applying the Diátaxis framework, which classifies content into tutorials, guides, reference materials, and explainers. This systematic classification reduces cognitive load by enforcing strict separation of content types based on user intent.

A tutorial teaches a skill by guiding beginners through a practical exercise, whereas a guide helps users solve specific real-world problems. The Diátaxis framework ensures your README matches the correct tone and structure for the user's needs.

Classify technical writing using a decision-making compass based on the axes of action versus cognition and acquisition versus application. This determines whether content should be a tutorial, guide, reference, or explainer.

Write reference materials when providing factual information for experts to consult during application, and write explainers to illuminate topics for cognition and understanding. The Diátaxis framework enforces this strict content separation.

Outline a new documentation set by systematically categorizing content into tutorials, guides, reference, and explainers using the Diátaxis framework. This provides a decision-making compass for content organization and ensures documentation consistency.

Yes, applying a content strategy framework like Diátaxis helps by providing specific writing principles for each category and enforcing strict separation of content types. This ensures your technical writing remains purposeful and easy to navigate.