Docgen

[H1][DOCGEN]

Dictum: Documentation is a typed contract between author and reader.

Single authority on documentation structure, content requirements, and generation workflow. Routes to task-specific references by document type. Code examples in references align with csharp-standards, python-standards, and ts-standards — those skills remain authority on code discipline; this skill governs documentation discipline.

[1][LOAD_SEQUENCE]

Dictum: Foundation references apply to every documentation task.

Step 1 — Foundation (always load first)

Step 2 — Task-specific (load per routing table)

Step 3 — Template (scaffolding only)

[2][CONTRACTS]

Dictum: Structural invariants constrain all documentation.

Content discipline

• Documentation completes type signature — encode intent, constraints, failure semantics, domain invariants. Never restate what types and names already communicate.
• Every document targets one Diátaxis quadrant: Tutorial (learning), How-To (task), Reference (information), Explanation (understanding). Mixing quadrants produces documents that serve no audience well.

Generation discipline

• Exploration before generation: Read project structure, dependencies, existing documentation before producing new content. Generated documentation contradicting existing artifacts is worse than no documentation.
• Code examples are compilable/runnable — never pseudocode, never truncated. For libraries: importable. For services: curl with expected response. For CLIs: exact invocation with output.
• Audience-first structure: Organize content by reader need, not by implementation topology.

Density discipline

• Standards docs (docs/standards/*.md): canonical truth about document types. 125-200 LOC.
• Skill references (references/*.md): generation-specific instructions. <250 LOC each.
• Templates (templates/*.md): structural skeletons with placeholders, guidance, and checklists. <125 LOC each.

[3][ROUTING]

Dictum: Task type determines reference loading.

[4][DECISION_TREES]

Dictum: Branching tables route ambiguous tasks.

Document type selection:

README scope routing:

README audience routing:

Code doc language routing:

[5][ANTI_PATTERNS]

Dictum: Named violations enable precise correction.

Summary table — full examples in patterns.md.

[6][VALIDATION]

Dictum: Gates prevent documentation debt.

[VERIFY]: Per-task completion — select checklist from validation.md matching document type.

[IMPORTANT]:

1. [ALWAYS] Load validation.md before marking any documentation task complete.
2. [ALWAYS] Verify code examples compile/run in the target language.

[CRITICAL]:

• [NEVER] Skip negative consequence documentation in ADRs.
• [NEVER] Ship a README without a runnable Usage example.
• [NEVER] Document code by restating type signatures.