design-docs

Adopts, authors, and audits a repository's ADR, rationale-index, and Diátaxis documentation standard.

1|1|Updated Aug 2, 2026
One-click install
npx skills add https://github.com/blac9216/waypoint --skill design-docs-blac9216
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: design-docs
Source: https://github.com/blac9216/waypoint/tree/main/.claude/skills/design-docs
Command: npx skills add https://github.com/blac9216/waypoint --skill design-docs-blac9216

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve? Design documentation rots quickly: ADRs lose status tracking, code comments cite dead tickets, and docs drift from the structure they claim to follow. This Skill gives a repository one enforceable documentation framework — MADR-style ADRs with a generated status index, a rationale index behind # why: code pointers, a C4-levelled architecture doc, a root glossary, and Diátaxis-organised docs — plus the scripts and audit procedure that measure drift against it. ## Core Features & Use Cases - Adopt mode: Surveys an existing repository, asks the owner only the adoption decisions, scaffolds the manifest, ADR index, rationale areas, glossary, and CI checks, and records the adoption as an ADR. - Author mode: Applies the ADR trigger test (hard to reverse, surprising, real trade-off) and writes decisions as ADRs, rationale entries with # why: pointers, glossary terms, or C4 architecture changes. - Audit mode: Runs scripted Tier 1 checks (pointer resolution, ADR index drift, MADR sections, Diátaxis layout, glossary consistency) and guides Tier 2 cross-reference checks, producing an ephemeral gap report handed to planning. - Use Case: A maintainer says "audit the docs" before a milestone; the Skill runs scripts/audit.sh, clusters findings like dead citations and missing ADR sections, and hands a sized remediation backlog to the planning workflow without editing anything. ## Quick Start Ask the agent to adopt the design-docs documentation standard in this repository and scaffold the ADR, rationale, and Diátaxis structure.

Frequently Asked Questions about design-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add Architecture Decision Records (ADRs) to a repository?▼

Use adopt mode to scaffold docs/adr/ with a README index, then author mode to write each decision in MADR format: Context, Decision Drivers, Considered Options, Decision, Consequences. Run adr-index.sh --write to regenerate the status table in the same PR.

How do I check documentation drift in a repo automatically?▼

Run scripts/audit.sh --out <path> on a full checkout. It executes check-pointers.sh, adr-index.sh --check, and structural checks against docs/doc-manifest.md, then writes a gap report with findings grouped by error code for remediation planning.

When should a decision become an ADR versus a code comment?▼

A decision becomes an ADR only when it is hard to reverse, surprising without context, and involved real alternatives. Smaller local 'why' explanations become 2-6 line rationale entries referenced by a `# why: docs/rationale/<area>.md#<slug>` pointer in code.

Does the ADR index table need manual editing?▼

No. The table between the adr-index markers in docs/adr/README.md is generated by adr-index.sh --write and verified in CI with --check. Hand edits cause ADR_INDEX_DRIFT findings and CI failure.

What are the limitations of the documentation audit?▼

The audit's Tier 1 checks are mechanical and cannot judge whether architecture.md semantically matches the code; that semantic review is an explicit, separately requested activity. The audit also edits nothing — it only writes an ephemeral gap report for planning.