docs-sync

Detect design-doc changes and propagate updates to user documentation.

Updated Jan 20, 2026
One-click install
npx skills add https://github.com/spencerbeggs/claude-design-coordinator --skill docs-sync-spencerbeggs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-sync
Source: https://github.com/spencerbeggs/claude-design-coordinator/tree/main/.claude/skills/docs-sync
Command: npx skills add https://github.com/spencerbeggs/claude-design-coordinator --skill docs-sync-spencerbeggs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Design teams frequently update design documents without updating user docs, leading to inconsistent knowledge. This skill detects design-doc changes and propagates updates to user documentation across readme, repository guides, and site docs while preserving custom user content.

Core Features & Use Cases

  • Syncs design-doc changes to Level 1 READMEs, Level 2 repository docs, and Level 3 site docs
  • Detects stale docs via timestamp comparisons and hashes
  • Preserves manual edits and handles conflicts
  • Updates sync timestamps and records a summary

Quick Start

Run the docs-sync command for the target module to begin syncing its design docs with user documentation.

Frequently Asked Questions about docs-sync

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

FAQPage Schema
How do I keep user documentation in sync with design docs automatically?

To sync design docs with user documentation, this skill detects changes via timestamp comparisons and hashes, then propagates updates across READMEs, repository guides, and site docs while preserving manual edits.

How does documentation change detection work for repository docs and site docs?

Change detection works by comparing timestamps and hashes between design docs and user docs to identify stale files, then performing impact analysis to determine which README, repository, or site docs require updates.

Can I preserve manual edits in user docs when syncing design doc changes?

Yes, manual edits are preserved during sync. The process handles conflicts selectively, ensuring custom user content in READMEs and site docs remains intact while propagating necessary design-doc updates to affected files.

What is the best way to sync README files with design documents?

The best way to sync READMEs with design documents is using a configuration-driven approach via .claude/design/design.config.json that validates content, handles conflicts, and updates sync timestamps after propagating changes.

Does documentation sync require a specific configuration file to work?

Yes, documentation sync is driven by the .claude/design/design.config.json file, which controls change detection, selective updates, validation, and conflict handling across your Level 1, 2, and 3 documentation layers.