review-doc-consistency
CommunityFind and fix docs that drift from code.
Software Engineering#documentation#verification#readme#OpenAPI#docs#code-review#documentation-consistency
AuthorHeyvhuang
Version1.0.0
Installs0
System Documentation
What problem does it solve?
The Documentation Consistency Reviewer helps teams identify when README/docs diverge from actual implementation, enabling efficient corrections and preventing user confusion.
Core Features & Use Cases
- Document-vs-code drift detection: Compare README/docs against code, OpenAPI, and config to surface inconsistencies.
- Evidence-based findings: Each issue cites concrete code or contract locations to support fixes.
- Use Case: When updating an API, quickly verify that docs reflect the current endpoints and schemas.
Quick Start
Install the skill and run a scan against your repository root to generate a report of documentation vs code inconsistencies.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: review-doc-consistency Download link: https://github.com/Heyvhuang/ship-faster/archive/main.zip#review-doc-consistency Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.