·review-doc-consistency
#

review-doc-consistency

heyvhuang/ship-faster

Documentation consistency reviewer that checks alignment between code implementation and documentation. Use when user requests reviewing documentation vs code consistency, checking if README/docs are outdated, verifying API documentation accuracy. Applicable for (1) reviewing README vs implementation consistency (2) checking if docs/ directory content is outdated (3) verifying API/config documentation accuracy (4) generating documentation consistency reports. Trigger words include doc review, documentation consistency, check outdated docs, verify docs.

0Installs·0Trend·@heyvhuang

Installation

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

SKILL.md

Systematically identify all "outdated" or "inconsistent with implementation" descriptions in README + docs/, outputting ≥30 issue items.

| P0 | Security issue/serious misleading | Docs say sandbox enabled but code doesn't enable it | | P1 | Core functionality inconsistency | Following docs leads to failure | | P2 | Incomplete examples/naming inconsistency | Doesn't directly block usage | | P3 | Wording/formatting/link minor issues | Doesn't affect functionality |

| Pending Evidence | Suspicious but insufficient evidence | Needs further investigation |

Documentation consistency reviewer that checks alignment between code implementation and documentation. Use when user requests reviewing documentation vs code consistency, checking if README/docs are outdated, verifying API documentation accuracy. Applicable for (1) reviewing README vs implementation consistency (2) checking if docs/ directory content is outdated (3) verifying API/config documentation accuracy (4) generating documentation consistency reports. Trigger words include doc review, documentation consistency, check outdated docs, verify docs. Source: heyvhuang/ship-faster.

View raw

Facts (cite-ready)

Stable fields and commands for AI/search citations.

Install command
npx skills add https://github.com/heyvhuang/ship-faster --skill review-doc-consistency
Category
#Documents
Verified
First Seen
2026-02-17
Updated
2026-02-18

Quick answers

What is review-doc-consistency?

Documentation consistency reviewer that checks alignment between code implementation and documentation. Use when user requests reviewing documentation vs code consistency, checking if README/docs are outdated, verifying API documentation accuracy. Applicable for (1) reviewing README vs implementation consistency (2) checking if docs/ directory content is outdated (3) verifying API/config documentation accuracy (4) generating documentation consistency reports. Trigger words include doc review, documentation consistency, check outdated docs, verify docs. Source: heyvhuang/ship-faster.

How do I install review-doc-consistency?

Open your terminal or command line tool (Terminal, iTerm, Windows Terminal, etc.) Copy and run this command: npx skills add https://github.com/heyvhuang/ship-faster --skill review-doc-consistency Once installed, the skill will be automatically configured in your AI coding environment and ready to use in Claude Code or Cursor

Where is the source repository?

https://github.com/heyvhuang/ship-faster