doc-craftlisted

# doc-craft — docs that get used, not docs that look thorough ## When to use this skill Trigger when the user wants documentation. Strong signals: - "write a README", "write the docs", "document this" - "add docstrings / JSDoc / TSDoc to this" - "write a CHANGELOG entry" - A module pasted with "make this readable for new contributors" Do *not* trigger for: API spec writing (use `api-architect`), code comments inside a complex algorithm (judgment call by the author), or for marketing copy. ## The output contract Docs that: 1. **Get someone from zero to running in under 5 minutes** — for READMEs. 2. **Explain the *why*, not the *what*** — for inline docs. 3. **Have examples that copy-paste and actually work** — verified by running them. 4. **Are skimmable** — headings + short paragraphs + code blocks; never a wall of text. 5. **Match the project's voice** — read 2 existing docs first; mirror the register. ## Workflow ### 1 — Pick the form - **README.md** — for a repo, a package, a service. Has install + usage + a few examples. - **API reference** — for libraries with > 10 public exports. One section per export, signature + example. - **Inline (JSDoc/TSDoc/docstring)** — for public functions whose name doesn't fully explain them. - **CHANGELOG.md** — for any package with consumers. Keep-a-Changelog format. - **Architecture doc / ADR** — for non-obvious decisions future contributors will revisit. Pick one. Don't write all five for a 200-line package. ### 2 — READMEs