writing-documentation-with-diataxis

What problem does it solve?

This Skill helps you create and refine technical documentation by applying the Diataxis framework, ensuring your content effectively meets user needs for learning or application.

Core Features & Use Cases

• Documentation Type Identification: Guides you to choose between Tutorials, How-to Guides, Explanations, and Reference based on user needs.
• Principle Application: Provides core principles for each documentation type to ensure quality and flow.
• Workflow Guidance: Offers structured workflows for both creating new documentation and reviewing existing content.
• Use Case: You need to write a new guide for a complex feature. This Skill helps you determine if it should be a step-by-step tutorial for learning, a how-to guide for practical application, an explanation for conceptual understanding, or reference material for technical details.

Quick Start

Use the writing-documentation-with-diataxis skill to determine the best documentation type for a new user guide.