mcpField
D
decision-doc-sync

decision-doc-sync

github.com/c3sc0-v4113Development33.4k installsUpdated today
Repository

About decision-doc-sync

decision-doc-sync is a skill for keeping project documentation aligned with structural decisions and code changes. It maps change types to existing documents or ADRs, and emphasizes recording decisions without duplicating facts.

Key features

  1. 01Classify structural decisions
  2. 02Map changes to documentation
  3. 03Update existing documents only
  4. 04Record durable decisions as ADRs
  5. 05Check docs against implementation

Use cases

  1. 01Documenting architecture changes
  2. 02Updating UI or UX standards
  3. 03Recording workflow and script conventions
  4. 04Reviewing docs after cross-cutting changes

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/c3sc0-v4113/scaffold --skill decision-doc-sync

After installing, type/decision-doc-syncin Claude Code to confirm it loaded.

Bundled filesreferences/doc-map.md

Details

From the project README

Decision Documentation Sync

Activation Contract

Load this skill when a change introduces or changes a structural decision: architecture, UI/UX standards, scripts or quality gates, or a cross-cutting convention.

Hard Rules

  1. Check which documents exist before editing; update only documents that exist, and create one only when a rule below requires it.
  2. Keep each fact in one document and link to it from others instead of duplicating it.
  3. Record the decision itself, not the change history.
  4. Never leave a document contradicting the code after the change.

Decision Gates

Change typeDocument
Architecture, folder structure, scriptsREADME.md
Visual or UX standard, tokens, component usageDESIGN.md
Agent workflow, commands, operational guidanceAGENTS.md
Durable decision with alternatives and consequencesnew record in docs/adr/

Execution Steps

  1. Check which of README.md, DESIGN.md, AGENTS.md, and docs/adr/ exist.
  2. Classify the change with the table above; one change may hit several rows.
  3. Update each affected document that exists.
  4. For an ADR, follow the existing numbering and format in docs/adr/; see references/doc-map.md.
  5. Reread the edited sections against the code.

Output Contract

List every document updated, created, or deliberately skipped, with a one-line reason each.

References

Comments

Markdown supported