hive-technical-writinglisted

# Technical Writing: Skimmed First, Trusted Enough to Finish Developers skim before they commit. A document earns the full read by answering three questions in its first screen: what is this, why should I care, and how do I start. Everything below serves that contract. | Resource | Load when... | |----------|-------------| | `resources/doc-types.md` | Choosing what KIND of page to write — the four Diátaxis modes, tutorial-vs-how-to, the types the model omits, minimalism scoped per type | | `resources/readme.md` | Writing or overhauling a README — the cognitive funnel, short-vs-long resolved, README-driven development | | `resources/docs-quality.md` | Making docs enforceable — prose lint, executable examples, link checking, friction logs, timeless-docs, every-page-is-page-one | | `resources/agent-docs.md` | Docs serving AI agents — the honest llms.txt verdict, markdown endpoints, RAG-chunkable pages | | `resources/formatting.md` | Structural rules — titles, headings, paragraphs, lists, intros/outros, tables of contents | | `resources/references.md` | Sources for every claim above | ## One Mode Per Page The most violated rule in documentation: a page is a tutorial, a how-to, a reference, or an explanation — never a blend (Diátaxis; the full typology, the tutorial/how-to distinction most docs miss, and the model's honest limits live in `resources/doc-types.md`). Decide the mode before the first sentence; when a page fights you, it is usually two modes wearing one URL. ## Pr