writing-documentation-with-diataxis

What problem does it solve?

This Skill eliminates confusion and poor structure in technical documentation by applying the proven Diataxis framework, ensuring your docs serve user needs effectively.

Core Features & Use Cases

• Documentation Type Identification: Uses the Diataxis compass to determine whether content should be tutorials, how-to guides, reference, or explanation based on user needs.
• Quality Framework: Provides detailed principles for each documentation type to ensure clarity, flow, and usability.
• Use Case: Imagine you're reviewing a messy documentation page that mixes instructions with explanations. Use this Skill to identify which parts belong to which documentation type and restructure accordingly.

Quick Start

Use the writing-documentation-with-diataxis skill to analyze this API documentation and suggest improvements based on Diataxis principles.