What problem does it solve?
It solves the problem of documentation that feels confusing, incomplete, or hard to navigate by enforcing clear document types, consistent reference patterns, and minimum coverage standards so readers can find answers without asking.
Core Features & Use Cases
- Diataxis document-type framework: Guides you to choose exactly one of Tutorial, How-to, Reference, or Explanation so each document has a single purpose and the right structure for its reader.
- Interface-element reference template: Standardizes how you document every CLI subcommand, API endpoint, config option, or similar element using consistent questions for identity, inputs, outputs, failure modes, and examples.
- Coverage standards for real readers: Ensures a new user can answer what the project does, how to install or access it, what minimal success looks like, how to use the primary interface, and how to contribute or develop locally.
- Practical writing principles: Improves clarity with audience-first planning, active voice, imperative instructions, present-tense descriptions, progressive disclosure, and concrete examples.
Quick Start
Load technical-writing before drafting or updating any documentation, then classify each document with Diataxis and fill in the interface-element template for every user-facing option or workflow.
