diff-driven-docs

diff-driven-docs

Overview

Stale documentation is worse than no documentation — it actively misleads contributors, users, and future maintainers. Run the Impact Classifier on the diff across the four layers (business, technical, audit, glossary); write only what a layer's verdict requires.

Impact Classifier

Run this classifier before any doc work. Use it to determine which layers to evaluate and which to skip.

Diff Characteristic	Business Layer	Technical Layer	Audit Layer	Glossary Layer
Internal utility, helper, or type change only	SKIP	CHECK	SKIP	SKIP
Test addition with no new pattern	SKIP	SKIP	SKIP	SKIP
Style / formatting change	SKIP	SKIP	SKIP	SKIP
Dependency version bump (no API change)	SKIP	SKIP	SKIP	SKIP
Routine bug fix (existing behavior corrected)	SKIP	CHECK	SKIP	SKIP
Simple refactor (behavior unchanged)	SKIP	CHECK if signatures changed	SKIP	SKIP
New exported function / hook / component	SKIP	CHECK	CHECK	SKIP
New page or route	CHECK	CHECK	CHECK	CHECK
Architectural pattern introduced	SKIP	CHECK	CREATE	CHECK
Technology choice made	SKIP	CHECK	CREATE	CHECK
Breaking change to public API	CHECK	CHECK	CREATE	CHECK
Permission or role change	CHECK	CHECK	CHECK	SKIP
Security or compliance impact	CHECK	CHECK	CREATE or UPDATE	SKIP
Domain term resolved or sharpened during the workflow	SKIP	SKIP	SKIP	CHECK

SKIP business docs if: no user-facing surface changed; only internal utils, types, or tests were modified.

ALWAYS check technical docs when hooks, components, migrations, schema, routes, or exported library APIs changed.

CREATE an audit doc if: an architectural decision was made, a new pattern was introduced, a non-obvious tradeoff was accepted, or a team member six months from now would ask "why did we do it this way?"

CHECK glossary docs if: a domain term was resolved, sharpened, or found to contradict the code during a BUILD/PLAN/DEBUG workflow. The glossary layer is written only by designated shaping phases (planner, exploration DESIGN mode, doc-syncer) via cc10x:domain-modeling; builders emit proposals. See the Glossary Layer section below.

If all four layers are SKIP, set IMPACT_LEVEL: none and emit a SKIPPED contract immediately without opening any doc files.

The Four Layers

Business Layer

User-facing guides, admin documentation, and feature descriptions. Business docs describe what users and administrators can do — not how the system works internally.

• Scope: user guides, admin guides, settings references, feature descriptions, permissions documentation
• Update trigger: new or changed user-facing behavior, new page or route, permission change, config option that affects user behavior
• What to write: describe the feature from the user's perspective; do not expose internal implementation details

Technical Layer

Hooks reference, components catalog, schema documentation, architecture notes, and JSDoc on exported APIs. Technical docs describe how the system is built — for developers working on the codebase.

• Scope: hooks reference, components catalog, API reference, edge function reference, database schema docs, environment variable docs, architecture notes
• Update trigger: any exported function, hook, or component whose signature was added or changed; any migration or schema change; any new route or page
• What to write: name, file path, description, signature, params, return value, key behaviors; for component-based frameworks, document component inputs (props, arguments, or slots)

Audit Layer

Decision records capturing what changed, why, alternatives considered, and impact. Audit docs are written for future contributors who need to understand the reasoning behind a decision.

• Scope: docs/adr/ (canonical, NNNN-numbered; legacy docs/decisions/ date-named files migrated lazily on touch), compliance notes, migration guides for breaking changes
• Update trigger: new architectural pattern, technology choice, non-obvious tradeoff, breaking change, security or compliance impact
• What to write: structured record following the four-section format below (or a single-paragraph ADR for simple decisions, per cc10x:domain-modeling/ADR-FORMAT.md)
• Dedup rule: if a decision exists in both docs/decisions/ and docs/adr/, the docs/adr/ version wins; delete the legacy duplicate — two live copies diverge, and readers can't tell which is authoritative

Glossary Layer

CONTEXT.md at the repo root — the project's domain language (terms and their meanings, no implementation details). Maintained inline by shaping phases (planner, exploration DESIGN mode, doc-syncer) via cc10x:domain-modeling.

• Scope: CONTEXT.md (root), or per-context CONTEXT.md files if CONTEXT-MAP.md exists
• Update trigger: a domain term is resolved, sharpened, or found to contradict the code during a BUILD/PLAN/DEBUG workflow
• What to write: append-only glossary entries using cc10x:domain-modeling/CONTEXT-FORMAT.md (term, one-two sentence definition, _Avoid_ aliases)
• Do NOT write implementation details, specs, or scratch notes in CONTEXT.md — it is a glossary only

Audit Doc Guidance

When to Create vs. Update

SKIP verdicts are owned by the Impact Classifier table above.

CREATE new when:

• A pattern is introduced for the first time in this codebase
• An architectural decision is made that future contributors will need to understand
• A non-obvious tradeoff is accepted (performance vs. correctness, simplicity vs. extensibility)
• A technology is chosen over alternatives

UPDATE existing when:

• An existing decision is amended or reversed
• A previous tradeoff is resolved differently in a new context
• Additional impact or context is discovered for a prior decision

Filename Pattern

docs/adr/NNNN-{topic}.md (canonical) — scan docs/adr/ for the highest existing number and increment. Legacy docs/YYYY-MM-DD-{topic}-decision.md files in docs/decisions/ are migrated to docs/adr/ on next touch. Use cc10x:domain-modeling/ADR-FORMAT.md for the format.

Audit Doc Structure

## What Changed
[One paragraph describing the technical change]

## Why
[The primary reason for this decision]

## Alternatives Considered
- **{Alternative A}:** [Why it was not chosen]
- **{Alternative B}:** [Why it was not chosen]

## Impact
[Who is affected; any migration steps; ongoing maintenance implications]

Workflow

The doc-syncer agent follows these five steps in order:

Step 1 — Get the diff

# For pre-commit (staged changes)
git diff --cached --stat && git diff --cached

# For post-build (last commit)
git diff HEAD~1 --stat && git diff HEAD~1

Read the full diff output before classifying.

Step 2 — Classify impact

Run the Impact Classifier table against the diff. Determine IMPACT_LEVEL and which layers to evaluate: none = all four layers SKIP; low = only the technical layer triggered and the changes are minor (rename, one-line fix); medium = technical layer triggered with signature changes, or one other layer triggered; high = multiple layers triggered, or the audit layer requires a new decision record. (Same scale cc10x:doc-syncer assigns — one definition in each place, same meaning.) If IMPACT_LEVEL is none, emit the SKIPPED contract immediately and stop.

Step 3 — Map changed files to doc targets

Use the project's ## Doc Targets from CLAUDE.md if present. Otherwise apply the generic heuristics in references/doc-target-heuristics.md. For each changed file, identify zero or more target documentation files.

Step 4 — Read then write

For each doc target:

1. Read the entire target file first — an unread edit duplicates sections and contradicts neighbors; the read is what makes the edit minimal
2. Apply minimal, targeted edits using Edit — do not rewrite sections that are not affected by the diff
3. Read the file again after writing to verify the edit landed correctly

For audit docs: check whether an existing decision doc covers this topic in docs/adr/ (canonical) or legacy docs/decisions/. If yes, update it (migrating legacy files to docs/adr/ on touch). If no, create a new file at docs/adr/NNNN-{topic}.md following the ADR format. For glossary docs: if a domain term was resolved or sharpened during the workflow, append it to CONTEXT.md (create lazily if missing) using the domain-modeling format — but only if this doc-syncer run is the designated writer (shaping phases write CONTEXT.md; builders emit proposals, see cc10x:domain-modeling).

Step 5 — Self-review

Before emitting the contract, verify:

• Every updated doc accurately reflects the diff (no hallucinated details)
• Cross-references between docs are consistent
• If a new doc file was created, it is indexed in the relevant ## Docs section of CLAUDE.md
• No doc content was duplicated in CLAUDE.md (it is an index only)

Router Integration

This skill is loaded by the doc-syncer agent in the BUILD chain. The router spawns doc-syncer after integration-verifier passes and before the Memory Update task. The agent emits a ### Router Contract (MACHINE-READABLE) YAML block that the router validates before advancing.

Opt-out: Add DIFF_DRIVEN_DOCS: skip to the ## Session Settings section of CLAUDE.md to disable the doc-syncer for projects that manage documentation separately.

Rationalization Table

Common excuse	Counter
"docs can wait"	Docs are a deliverable, not a follow-up. The workflow does not close until they are done.
"it's just a refactor"	If file paths, function signatures, or exported APIs changed, technical docs need updating.
"the diff is small"	Run the Impact Classifier. Small diffs still trigger technical doc updates when signatures change.
"nobody reads those docs"	Stale docs actively mislead. Empty docs are better than wrong ones.
"I'll add JSDoc later"	JSDoc on exported APIs is a technical doc update. Later means never.
"the tests document the behavior"	Tests document correctness, not usage. They are not a substitute for doc updates.