diataxis-documentation

What problem does it solve?

Poorly organized or unclear documentation frustrates users and wastes time. This skill helps you create high-quality, user-focused documentation by applying the Diataxis framework, ensuring each piece of content serves a specific user need (tutorial, how-to, reference, explanation).

Core Features & Use Cases

• Documentation Type Identification: Guides you to correctly classify content as a tutorial, how-to guide, reference, or explanation based on user context and content nature.
• Best Practice Application: Provides detailed guidelines for structuring, writing, and styling each documentation type, ensuring clarity and effectiveness.
• Iterative Improvement Workflow: Supports continuous, small-scale enhancements to existing documentation, making quality improvement manageable and immediate.
• Use Case: You need to write a "Getting Started" guide for a new feature. Use this skill to identify it as a "Tutorial," then load the specific reference to ensure it focuses on learning by doing, provides immediate success, and avoids over-explanation.

Quick Start

Use the diataxis-documentation skill to help me write a "How to deploy to production" guide, ensuring it follows best practices for how-to guides.