What specific files does Doc Sync monitor?

It primarily focuses on CHANGELOG.md, CLAUDE.md, README.md, and DESIGN_SYSTEM.md, checking for consistency between the code changes and these descriptive files.

When does the documentation reminder trigger?

The skill triggers at the end of a task if significant changes are detected, such as new files, API endpoint updates, or architectural shifts. It avoids triggering for minor changes like typos.

Does Doc Sync automatically edit my documentation files?

No, Doc Sync is designed to be a non-intrusive assistant. It provides reminders and suggests templates, but it will not modify your files automatically without your explicit validation.

Can I disable reminders for specific tasks?

Yes, you can explicitly ask the skill to 'skip doc' or indicate 'no doc' in your prompt, and it will suppress the reminder for that specific workflow.

Doc Sync Manager

Name: Doc Sync Manager
Author: vendeesign

byvendeesign

0•

学习与文档

Ensures project documentation stays synchronized with code changes by providing intelligent reminders for CHANGELOG, README, and architectural updates.

Doc Sync is a specialized skill designed to combat documentation debt by monitoring significant code modifications and prompting necessary updates to key project files. It intelligently detects high-impact changes—such as new features, API modifications, or dependency additions—while ignoring minor tweaks like typos or formatting. By providing non-blocking reminders and providing standardized templates for CHANGELOGs and API docs, it helps maintain a high-quality codebase where the documentation accurately reflects the current state of the project without disrupting the developer's flow.

主要功能

01Automated tracking for CHANGELOG.md, README.md, and CLAUDE.md status

02Standardized template suggestions for Design Systems and API documentation

03Intelligent change detection for features, APIs, and project architecture

04Context-aware filtering to ignore minor refactors, typos, and test-only changes

050 GitHub stars

06Non-blocking aggregate reminders delivered at the end of development tasks

使用场景

01Maintaining an accurate project CHANGELOG during rapid feature development cycles

02Standardizing documentation across team members using built-in reference templates

03Ensuring CLAUDE.md reflects the latest project structure and dependencies for AI context

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add vendeesign/codebloom doc-sync

For use in Claude.ai and ChatGPT

Download Skill