review-doc-consistency

Identify documentation conflicts with code and configurations across a repository.

339|58|Updated Jan 10, 2026

Search Tags:#documentation #verification #readme #OpenAPI #docs #code-review #documentation-consistency

Ready to run

npx skills add https://github.com/Heyvhuang/ship-faster --skill review-doc-consistency

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: review-doc-consistency
Source: https://github.com/Heyvhuang/ship-faster/tree/main/skills/review-doc-consistency
Command: npx skills add https://github.com/Heyvhuang/ship-faster --skill review-doc-consistency

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about review-doc-consistency

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I find outdated documentation that conflicts with my code?▼

To find outdated README files, scan your repository to compare markdown documentation against actual code and configurations. This process surfaces inconsistencies by outputting a concise list of issues with cited evidence to support fixes.

How do I verify my OpenAPI documentation matches the current API endpoints?▼

You can verify OpenAPI documentation by scanning contract files and comparing them against code implementation. This surfaces mismatched schemas and endpoints, ensuring your docs accurately reflect the current API with cited evidence.

What is documentation drift and how do I detect it in a repository?▼

Documentation drift occurs when README files diverge from actual implementation. You detect it by scanning your repository root to compare markdown and contract files against code, generating a report of inconsistencies to prevent user confusion.

Does documentation consistency verification work with TypeScript types and configurations?▼

Yes, documentation consistency verification works with TypeScript types and configurations across the repository. It applies these contract files alongside markdown docs to surface outdated information with cited code locations.

What is the best way to fix README files that do not match the codebase?▼

The best way to fix mismatched README files is to run a scan against your repository root to generate a report of documentation versus code inconsistencies. This provides evidence-based findings to support efficient corrections.

When do I need to check documentation consistency in my software engineering workflow?▼

You need to check documentation consistency when updating an API or modifying code configurations to verify that docs reflect the current endpoints and schemas. This prevents user confusion caused by documentation drifting from implementation.