← ClaudeAtlas

doc-standardslisted

Documentation writing-quality standards — controlled language (ASD-STE100), Google/Microsoft style guide rules, ISO 24495 plain language, AI/agent readability (llms.txt, self-contained sections), and a machine-checkable lint gate. Use whenever writing or reviewing ANY documentation prose — README, API reference, tutorial, how-to, changelog, error message, code comment blocks, llms.txt — even if the user only says "write docs", "document this", "improve the README", "docs smell like AI", or "make the docs clearer". Structure/coverage questions (which doc types exist) belong to a Diátaxis-structure skill if one is installed; THIS skill governs how each sentence and section is written, and provides the lint gate to verify it.
JuanMarchetto/doc-standards-skill · ★ 13 · AI & Automation · score 78
Install: claude install-skill JuanMarchetto/doc-standards-skill
# doc-standards — write documentation that survives translation, retrieval, and skepticism Documentation written by an LLM has a smell: elegant-variation synonyms, subordinate clauses, filler, hedging. The fix is not "write better" — it is adopting the constraints professional documentation systems already use. This skill stacks five criteria layers, from structure down to the word, and ends in a machine gate. ## The five layers | Layer | Question it answers | Source standard | |-------|--------------------|-----------------| | 1. Structure | Which document am I writing, for whom? | Diátaxis + ISO 24495 | | 2. Controlled language | Is each sentence unambiguous? | ASD-STE100 | | 3. House style | Is it consistent with developer-docs convention? | Google / Microsoft style guides | | 4. AI readability | Can an agent retrieve and use each section alone? | llms.txt + retrieval practice | | 5. Verification | Can a machine confirm 2–4? | Vale / bundled checker | ## Workflow ### 1. Structure first (delegate, don't duplicate) Classify the document before writing a word: **tutorial, how-to, reference, or explanation** (Diátaxis). Each has a different contract with the reader — a tutorial promises safe success, a reference promises completeness, a how-to promises a working result, an explanation promises understanding. Mixing them is the #1 structural defect. - Generating new docs or auditing coverage → if a Diátaxis-structure skill is installed (for example gstack's `document-g