Documentation Sync Skill

What problem does it solve?

This Skill ensures that your project documentation stays up-to-date with code changes, preventing outdated information and improving developer onboarding and maintenance.

Core Features & Use Cases

• Feature vs. Implementation Gap Analysis: Compares documentation (like FEATURE files) against actual code to identify discrepancies.
• README Update Verification: Checks if changes are reflected in the README, including new commands, updated usage, or new dependencies.
• PATTERNS.md Synchronization: Verifies that new patterns are added to docs/PATTERNS.md and that code examples are accurate.
• Use Case: After implementing a new API endpoint, use this Skill to automatically verify that the API is documented correctly in the relevant feature file, the README, and any pattern documentation.

Quick Start

Run the documentation sync skill to verify that code changes are reflected in the README and PATTERNS.md files.