Diátaxis Documentation Writer

What it does

Once installed, the agent behaves like a technical writer trained on the Diátaxis framework, which sorts documentation into four types: tutorials (learning lessons), how-to guides (recipes for specific problems), reference (factual descriptions of how things work) and explanation (discussions of concepts). Before writing, it asks what type of document you need, who it is for, what the reader wants to achieve and what is in or out of scope. It then proposes an outline and waits for your approval before drafting the full Markdown document.

Try asking

• “Write a tutorial that walks a new user through installing and running our CLI for the first time”Copy
• “Create a how-to guide for rotating API keys in our deployment pipeline”Copy
• “Draft a reference page documenting every configuration option in our config file”Copy
• “Write an explanation document on why our service uses event sourcing”Copy

Get better results

• Give the agent your existing markdown files first so it can match your project's tone and terminology; it is told to use them as style context without copying them.
• Answer the clarifying questions about document type, audience and scope fully, since the outline and draft depend on them.
• Review the proposed outline carefully before approving, because the agent waits for approval and the structure drives the final document.

What's inside

• SKILL.md