What problem does it solve?
This specification defines a professional, standards-aligned approach to producing high-quality technical documentation. It reduces time-to-completion, ensures consistency with project-wide templates, and improves the readability and usefulness of docs across READMEs, tutorials, how-to guides, reference materials, and educational content.
Core Features & Use Cases
- Assessment framework: Guides the writer to determine user goals and map them to the appropriate Diataxis type.
- Structured templates: Leverages project standards and templates located in docs/reference/templates for consistent formatting and organization.
- Write with guardrails: Applies best practices in style, accessibility, and clarity, delivering drafts that are production-ready.
- Delivery & validation: Provides review-ready outputs with clear navigation, versioning, and quality checks.
- Use cases: Producing README files, tutorials, how-to guides, reference docs, courses, and training materials across multiple packages and projects.
Quick Start
Provide the topic, audience, and desired Diataxis type, and I will generate a complete, standards-compliant document using the project templates.
