Documentation Change Sync

Acerca de

Maintains high-quality project documentation by providing a rigorous, multi-step verification process to be used before every commit. Instead of relying on manual spot-checks, this skill guides users through a comprehensive sweep of core files such as READMEs, CLAUDE.md, and CHANGELOGs, while also checking package metadata and performing deep searches for cross-references. By identifying exactly what has been staged and searching for related terms throughout the codebase, it prevents broken examples, stale API documentation, and user confusion, ensuring that the documentation remains a reliable source of truth for both human contributors and AI agents.

Características Principales

• 0 GitHub stars
• Staged-change analysis via git diff to identify exactly what functionality has been modified
• Project-specific metadata verification for package.json, pyproject.toml, and OpenAPI specs
• Significance logic to determine when high-level documentation needs updates versus internal refactors
• Comprehensive checklist for core files including README, CLAUDE.md, CHANGELOG, and DESIGN_DOC
• Grep-based cross-reference searching to find and update mentions of features in unrelated files

Casos de Uso

• Ensuring package metadata and versioning are consistent across multiple files during a release
• Performing a systematic audit of API documentation after modifying functional endpoints
• Verifying that all related documentation is current before creating a pull request