doc-sync-sentinel
Automatically synchronizes documentation with code changes. Detects drift between source code and READMEs, Wikis, or comments, and suggests autonomous updates.
Resources
2Install
npx skillscat add famaoai-creator/gemini-skills/doc-sync-sentinel Install via the SkillsCat registry.
About this skill
This skill monitors code and documentation for inconsistencies, identifying when updates are needed due to code changes. It addresses the issue of outdated documentation by proposing automatic revisions to align with current code states. Developers or agents should use it during regular maintenance or after significant code updates to maintain accuracy.
SKILL.md
Doc-Sync Sentinel
This skill ensures that documentation never becomes stale by keeping it in perfect sync with the implementation.
Capabilities
1. Drift Detection
- Analyzes recent commits and compares them against existing documentation (README, internal docs, JSDoc).
- Identifies specific sections that are no longer accurate due to code changes.
2. Autonomous Update
- Generates updated documentation text that reflects the current state of the code.
- Can automatically propose PRs to fix documentation drift.
Usage
- "Check for documentation drift in the
api/directory and update the relevant README files." - "Ensure all JSDoc comments in
src/utilsmatch the current function signatures."
Knowledge Protocol
- This skill adheres to the
knowledge/orchestration/knowledge-protocol.md. It automatically integrates Public, Confidential (Company/Client), and Personal knowledge tiers, prioritizing the most specific secrets while ensuring no leaks to public outputs.
Categories
Install
npx skillscat add famaoai-creator/gemini-skills/doc-sync-sentinel Install via the SkillsCat registry.