Does this skill overwrite my entire README?

No, it is designed to only update specific sections like command tables and configuration examples while preserving your manual introductions, installation guides, and other custom content.

Does it automatically commit changes to my repository?

No, it performs the edits and displays a git diff summary along with a suggested commit message, but it leaves the final commit action to the user.

How does the skill know what to update?

It uses an 'Explorer' task to analyze core project files like config.mjs and platform.mjs to extract the current state of the application before passing that data to specialized writers.

Can I sync only one specific file instead of both?

Yes, you can use the --readme-only or --claude-only arguments to target a specific documentation file depending on your needs.

Project Documentation Sync

Name: Project Documentation Sync
Author: CaesiumY

byCaesiumY

•

内容管理

Automates the synchronization of README.md and CLAUDE.md files by analyzing source code to ensure documentation stays updated with implementation.

This skill streamlines the development workflow by serving as a final step in a coding session, ensuring that project documentation never lags behind the source code. It utilizes a multi-stage agentic workflow to extract configurations, platform support details, and design patterns directly from the codebase, then intelligently updates specific sections of the documentation while preserving manual edits. This prevents documentation rot and ensures that both human-facing READMEs and AI-facing CLAUDE.md files remain accurate sources of truth for the dding-dong project.

主要功能

01Post-sync verification with git diff and commit suggestions

02Automated source code analysis to extract configuration and command metadata

03Parallel synchronization of README.md and CLAUDE.md files

04Intelligent section-specific updates that preserve manual content

052 GitHub stars

06Support for cross-platform logic and environment variable documentation

使用场景

01Syncing documentation after adding new CLI commands or configuration options

02Finalizing a coding session to ensure the repository state is accurately reflected in docs

03Maintaining an up-to-date CLAUDE.md for better AI context in future sessions

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add caesiumy/dding-dong wrap-up

For use in Claude.ai and ChatGPT