documentation-writer
Installation
SKILL.md
Diátaxis documentation writer
Own document-type classification and quality constraints using the Diátaxis framework. For a substantial collaborative document, classify it first and then hand the drafting process to doc-coauthoring; for a small edit, work directly.
Document types
Choose the type before drafting:
- Tutorial: learning-oriented guidance that teaches through a successful outcome.
- How-to guide: problem-oriented steps that solve a specific task.
- Reference: information-oriented descriptions of APIs, commands, configuration, and other machinery.
- Explanation: understanding-oriented discussion of concepts, design, and trade-offs.
Workflow
- Clarify: Identify the document type, audience, reader goal, scope, and exclusions. Ask only questions that materially affect the result.
- Outline: Propose a structure with a short purpose for each section. For substantial documents, wait for approval before drafting.
- Draft: Write well-formatted Markdown with clear headings, concrete examples, and consistent terminology.
- Verify: Check claims, examples, links, code, terminology, and the document type. Ground technical details in repository sources or user-provided references.