documentation-writer
Write clear, scannable documentation with a research-first, phase-separated workflow. Pick one Diátaxis mode, then apply STE and Global English. Apply when the user asks for documentation, READMEs, do
SKILL.mdskills/documentation-writer/SKILL.md
GitHubDocumentation Writer
Leading words: research-first, Diátaxis mode, BLUF, STE, Global English, evidence-aware, phase separation.
Research-first technical documentation. Chat stays Caveman; the document is Standard Professional Mode.
Copy these phases into the todo list verbatim. A skipped phase stays with
skip: <reason>.
- Discover — list every file/API/feature the docs must cover.
- Research — primary sources for versions, flags, install commands.
- Outline — name the Diátaxis mode; BLUF per section.
- Draft — STE / Global English; slop catalog for artifacts.
- Verify — examples run; citations still match.
Mode table: references/diataxis.md. Sentence craft: references/style.md. Slop ids: references/slop-catalog.md.
Subagents
If the host can launch a Task / explore subagent, use a read-only explore
pass for a large or unfamiliar codebase before drafting. Use web search for
anything version-sensitive. Do not assume those tools exist.
Phase 1 — Discover
Read relevant files. Delegate broad mapping to explore when available.
Exit: you can list every file/API/feature the docs must cover.
🛑 Do not proceed to Research until the user confirms the scope (or you are
explicitly operating solo and the scope is unambiguous). Ask with the host's
structured question tool. Prompt in plain English. Last option:
Say this in plain English (meta: rephrase + example, do not advance).
Phase 2 — Research
Web research before asserting facts about APIs, CLI flags, install commands, LTS timelines, or security claims. Prefer primary sources. Capture citations. If sources conflict, say what is uncertain.
Exit: every claim you will make has a source link. 🛑 Do not proceed to Outline until Research is complete.
Phase 3 — Outline
Name the Diátaxis mode. Headings, audience, prerequisites. BLUF: lead each section with the direct answer in 40–60 words.
Exit: skeleton approved.
🛑 Present the outline. Do not draft until confirmed. Ask with the host's
structured question tool. Prompt in plain English. Last option:
Say this in plain English (meta: rephrase + example, do not advance).
Phase 4 — Draft
Apply references/style.md and the slop catalog. Start each section with the BLUF answer. Tables for comparisons. Concrete examples first.
Exit: every outline section has content.
Phase 5 — Verify
Re-read against the repo. Re-check critical external claims. Run code examples when possible.
Exit: every example runs as documented; every external claim matches the cite.
Standard file shape
- Title + 1–2 sentence summary (BLUF).
- Quick start — exact commands.
- Usage / examples — most common case first.
- API / reference if needed — tables.
Reply contract
Name the Diátaxis mode, the files written, and any claim still unverified.