update-documents
/update-documents
Synchronizes documentation between CLAUDE.md, README.md, and docs/. Resolves documentation inconsistencies across project files with configurable sync rules and whitespace-tolerant comparison. Use when the user asks to "sync the docs", "update documentation", "make README and CLAUDE.md consistent", or after changes that affect several documentation files.
- Author
- talent-factory ↗
- Repository
- claude-plugins ↗
- Licence
- MIT
- Last repository change
- 12.11.2026
Assessment and security
- Files in this package
- 7
- Scripts
- 5
- HTML comments
- 0
- URLs in SKILL.md
- 0
No signals detected. Repository changed on 12.11.2026, without references to retired models or APIs.
MIT, open: use and modify while retaining author attribution.
- 5 scripts in this package. Review them before installing, as Claude may execute them.
Scripts: scripts/__init__.py, scripts/extractor.py, scripts/main.py, scripts/sync_rules.py, scripts/writer.py
What it does and when to use it
Synchronizes documentation between CLAUDE.md, README.md, and docs/. Resolves documentation inconsistencies across project files with configurable sync rules and whitespace-tolerant comparison. Use when the user asks to "sync the docs", "update documentation", "make README and CLAUDE.md consistent", or after changes that affect several documentation files.
Triggers from the description
Original author description
Synchronizes documentation between CLAUDE.md, README.md, and docs/. Resolves documentation inconsistencies across project files with configurable sync rules and whitespace-tolerant comparison. Use when the user asks to "sync the docs", "update documentation", "make README and CLAUDE.md consistent", or after changes that affect several documentation files.
How it works
- Sync Rules
- Workflow
- Customize Configuration
- Notes
SKILL.md preview
---
name: update-documents
description: Synchronizes documentation between CLAUDE.md, README.md, and docs/. Resolves documentation inconsistencies across project files with configurable sync rules and whitespace-tolerant comparison. Use when the user asks to "sync the docs", "update documentation", "make README and CLAUDE.md consistent", or after changes that affect several documentation files.
---
# Update Documentation
Automatically synchronize project documentation between the various documentation files.
## Sync Rules
| 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.
## Workflow
### 1. Run Analysis
First check the current sync status:
```bash
cd ${PROJECT_ROOT} && python ${SKILL_DIR}/scripts/main.py --analyze
```
### 2. Interpret Output
The script displays:
- Synchronized: sections are identical
- Outdated: target differs from source
- Missing: section does not exist
### 3. Synchronize When Differences Are Found
If differences were found:
```bash
cd ${PROJECT_ROOT} && python ${SKILL_DIR}/scripts/main.py --sync
```
### 4. Review Results
After synchronization:
- Check the updated files for correct formatting
- Ensure no context-specific adjustments were lost
- If needed: manual post-processing for target-specific phrasing
### 5. Output Summary
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
```
## Customize Configuration
The sync rules are defined in `${SKILL_DIR}/config/sync_rules.json`.
Add a new rule:
```json
{
"id": "new-rule",
"source": {"file": "SOURCE.md", "section": "Section Name"},
"targets": [
{"file": "TARGET.md", "section": "Target Section"}
]
}
```
## Notes
- **No automatic commits**: The skill only modifies files, it does not commit
- **Whitespace-tolerant**: Minor formatting differences are ignored
- **Section matching**: Case-insensitive heading search
- **Backup**: Create manually before synchronization if needed
Files in this package (7)
- SKILL.md 2 KB
- config/sync_rules.json 1 KB
- scripts/__init__.py 1 KB
- scripts/extractor.py 4 KB
- scripts/main.py 9 KB
- scripts/sync_rules.py 2 KB
- scripts/writer.py 4 KB
Versions
The database has no other skills named update-documents.
Database snapshot: 13.11.2026 · package version 3b458dcf9383 (SHA-256 digest of the entire package)
Downloads in the last 30 days: 0 · ranking
Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.
Similar skills
- 100docs
Authors, audits, and maintains project docs — CLAUDE.md / .claude/rules/, AGENTS.md, README.md, and Diátaxis docs/ trees — in modes init, update, readme, and audit. Triggers on "init claude", "update docs", "docs drift", "write a README", "/docs". - 100repo
Update repository documentation (README.md, docs/, CLAUDE.md) based on session changes by dispatching the up-docs-propagate-repo sub-agent. This skill should be used when the user runs /up-docs:repo. - 100sync-docs
Use when the user asks to sync, update, or refresh CLAUDE.md, AGENTS.md, SKILL.md, and README.md to reflect recent commits or PRs. Triggers on phrases like "sync docs", "update CLAUDE.md", "update AGENTS.md", "update SKILL.md", "update README", "reflect recent changes", or "document the recent PRs". - 90update-project
Use when updating docs, syncing AGENTS.md, CLAUDE.md, or README.md, fixing stale documentation, or refreshing project rules and skills. Keeps docs aligned with code changes. - 100readme-generator-free
Generate polished README files from project code. Use when the user says "generate readme", "create README", "write project documentation", "make a readme", or asks for README generation, project documentation, installation docs, usage docs, API docs, badges, or repository… - 100docs-update
Audit project documentation against the current state of the codebase and produce a revision plan. Reads README and all docs, launches parallel Explore agents to verify claims, diffs documentation vs reality, and applies approved fixes. Use when user says "quality-docs-update",…