What is the recommended source of truth for this skill?

Following best practices for Claude Code, this skill treats CLAUDE.md as the primary technical source of truth and README.md as the user-facing entry document.

Can I define my own synchronization rules?

Yes, sync rules are fully customizable via the sync_rules.json file, allowing you to map specific sections from any source file to multiple target files.

Does this skill automatically commit changes to Git?

No, the skill only modifies files on your local disk. This allows you to review the synchronization results before manually committing them to your repository.

How does it handle minor formatting differences?

The skill is whitespace-tolerant, meaning it ignores minor indentation or spacing differences and only flags sections for update when the actual content differs.

How do I preview changes before they are applied?

You can run the analysis command first. It will provide a summary of which sections are currently synchronized, outdated, or missing without modifying any files.

Documentation Sync Pro

Name: Documentation Sync Pro
Author: talent-factory

bytalent-factory

•

Content Management

Synchronizes technical documentation across README.md, CLAUDE.md, and project docs to maintain a consistent source of truth.

Documentation Sync Pro is a specialized Claude Code Skill designed to solve the problem of fragmented and outdated project documentation. By establishing CLAUDE.md as the technical source of truth, this skill allows developers to automatically propagate updates—such as tech stack changes, development commands, and project structures—to the README.md and documentation folders. It features a whitespace-tolerant comparison engine and configurable sync rules, ensuring that internal technical notes and user-facing guides remain perfectly aligned without manual copy-pasting or human error.

Key Features

01Case-insensitive heading matching for reliable section identification

02Automated synchronization between CLAUDE.md, README.md, and /docs

033 GitHub stars

04Configurable JSON-based sync rules for custom file mappings

05Pre-sync analysis mode to identify outdated or missing sections

06Whitespace-tolerant comparison to ignore minor formatting variations

Use Cases

01Ensuring project structure visualizations remain consistent across all repository entry points

02Updating technical stack details in the README and docs after changing project dependencies

03Propagating new local setup instructions from internal dev notes to public documentation

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add talent-factory/claude-plugins update-documents

For use in Claude.ai and ChatGPT

Download Skill