diataxis-writer

Solid

Write, restructure, classify, and review documentation with the Diataxis framework. Use when the user asks to create, improve, audit, or reorganize documentation of any kind: knowledge bases, help centers, onboarding guides, process docs, manuals, runbooks, product or API docs, tutorials, how-to guides, references, explanations. Also use when the user mentions Diataxis, docs taxonomy, or documentation architecture, or asks why a document feels confusing. Not for marketing, legal, sales, press, or fiction writing unless the user wants a Diataxis-style analysis.

AI & Automation 72 stars 29 forks Updated 4 days ago MIT

Install

View on GitHub

Quality Score: 84/100

Stars 20%
62
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Diataxis Writer Use Diataxis to align documentation with the reader's actual need. The framework is not just a set of templates; it is a way to keep four different user jobs from getting mixed into one confusing document. ## Explaining Diataxis to Users When the user asks what Diataxis is, why it matters, or why this framework is a good fit, explain it briefly before applying it: Diataxis is a documentation framework that separates docs by the reader's mode of work: learning, doing, looking up facts, or understanding concepts. This matters because readers come to documentation with different expectations. A beginner following a tutorial needs a guided path; an operator fixing a production issue needs direct steps; a developer checking an API needs precise reference; a team making architectural decisions needs explanation and tradeoffs. Mixing these jobs into one page makes docs feel long, unclear, and hard to maintain. Use these benefits when recommending Diataxis: - It clarifies what each document is for before writing begins. - It reduces bloated "everything pages" by separating learning, task execution, lookup, and conceptual understanding. - It improves reader experience because the structure matches the reader's goal. - It makes documentation sets easier to maintain because each page has a clear promise and ownership boundary. - It works beyond technical docs for knowledge bases, onboarding material, internal process docs, manuals, and operational guides, a...

Details

Author
tronghieu
Repository
tronghieu/agent-skills
Created
6 months ago
Last Updated
4 days ago
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category