developer-docs-framework

# diataxis-docs-framework

Enterprise technical documentation framework — 27 rules, 11 references, 6 pluggable style guides. Content architecture, writing standards, information architecture, DX strategy, documentation audit, anti-patterns checklist.

## What This Does

A comprehensive framework for writing, planning, auditing, and improving technical documentation for products that need developer and partner adoption. Synthesizes six proven frameworks:

- **Diataxis** — Content architecture (tutorials, how-to guides, reference, explanation)
- **Google OpenDocs** — Project archetypes, maturity assessment, audit methodology
- **Good Docs Project** — Content type templates with writing guides
- **Google Style Guide** — Language, tone, and formatting standards
- **Stripe DX Patterns** — Outcome-oriented docs, developer journey design
- **Canonical Practice** — Documentation as engineering discipline

## Key Features

- **27 rules** across 7 categories: content architecture, writing style, information architecture, DX, audit, governance, partner ecosystem
- **14 content types** with detailed writing guidance: tutorial, quickstart, how-to, integration guide, migration guide, troubleshooting, API reference, SDK reference, config reference, changelog, explanation, architecture guide, glossary, runbook
- **6 pluggable style guides**: Diataxis (default), Google, Microsoft, Stripe, Canonical, Minimal
- **Anti-patterns checklist** — consolidated documentation smells for review
- **Ready-to-use templates** for every content type
- **Documentation maturity model** (Seeds → Foundation → Integration → Excellence)
- **Adoption funnel** for prioritizing documentation work

## Structure

```
diataxis-docs-framework/
├── SKILL.md                        — Quick reference, rule summaries, decision trees
├── AGENTS.md                       — Complete compiled guide with all rules expanded
├── references/
│   ├── content-types.md            — 14 content types: purpose, structure, principl