What problem does it solve?
This Skill addresses the critical issue of project drift, where code, documentation, and configuration become out of sync, leading to errors, maintenance nightmares, and reduced development velocity.
Core Features & Use Cases
- Version Consistency: Verifies that version numbers are uniform across all project files (e.g.,
package.json, CHANGELOG.md).
- Terminology Synchronization: Detects and helps migrate deprecated terms used within the project's codebase and documentation.
- Fact Accuracy: Ensures that any stated counts or facts within documentation accurately reflect the current project state.
- Diagram Validation: Checks if diagrams (Mermaid, ASCII) are up-to-date with current terminology, counts, and flows.
- Cross-Reference Integrity: Validates that all internal links, anchor links, and image references within the project resolve correctly.
- Code-to-Docs Sync: Confirms that code artifacts (functions, commands, errors) are accurately reflected in their corresponding documentation.
- Configuration Alignment: Verifies that configuration files (
.json, .ts) and environment variables are consistent with documentation.
- Use Case: Before a major release, run this audit to catch any inconsistencies in versioning, outdated diagrams, or broken links that could jeopardize the release.
Quick Start
Perform a comprehensive project consistency review across code, documentation, diagrams, and configuration.
