Stats
Actions
Tags
From development
Synchronizes documentation between CLAUDE.md, README.md, and docs/. Resolves documentation inconsistencies across project files with configurable sync rules and whitespace-tolerant comparison.
How this skill is triggered — by the user, by Claude, or both
Slash command
/development:update-documentsThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
Automatically synchronize project documentation between the various documentation files.
Automatically synchronize project documentation between the various documentation files.
| Source | Section | Targets |
|---|---|---|
| CLAUDE.md | Tech Stack | README.md, docs/index.md |
| CLAUDE.md | Development Commands | README.md, docs/development/local-setup.md |
| CLAUDE.md | Project Structure | README.md |
| README.md | Quick Start | docs/getting-started/quickstart.md |
Principle: CLAUDE.md is the technical source of truth; README.md is the user-facing entry document.
First check the current sync status:
cd ${PROJECT_ROOT} && python ${SKILL_DIR}/scripts/main.py --analyze
The script displays:
If differences were found:
cd ${PROJECT_ROOT} && python ${SKILL_DIR}/scripts/main.py --sync
After synchronization:
Provide the user with a brief summary:
Documentation synchronized
Updated:
- README.md: Tech Stack, Development
- docs/index.md: Tech Stack
Unchanged:
- docs/getting-started/quickstart.md
The sync rules are defined in ${SKILL_DIR}/config/sync_rules.json.
Add a new rule:
{
"id": "new-rule",
"source": {"file": "SOURCE.md", "section": "Section Name"},
"targets": [
{"file": "TARGET.md", "section": "Target Section"}
]
}
npx claudepluginhub talent-factory/claude-plugins --plugin developmentSyncs project markdown docs after commits and PR creation. Scans .md files, cross-references git diff, auto-updates factual content, checks consistency, updates PR body.
Synchronizes CLAUDE.md navigation indexes and README.md architecture docs across repositories. Activates on 'sync docs', 'update CLAUDE.md files', 'audit documentation', or after code changes.
Synchronizes frontend project documentation (README, docs, ADRs, changelogs) with source-of-truth files like package.json, config, routes, API clients, schemas, tests, and CI config to prevent drift. Useful when updating docs after code changes.