review-doc-consistency

Installation
SKILL.md

Documentation Consistency Reviewer

Goal

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

Core Principles

  1. Code is truth - When documentation conflicts with code, source code/config/contract files are authoritative
  2. Evidence before conclusions - Each issue must cite code/config location as evidence
  3. Contracts first - OpenAPI/proto/schema/TS types are treated as SSOT (Single Source of Truth)
  4. Security default tightening - Security-related inconsistencies are prioritized as high severity

Review Process

1. Document Enumeration

# Scan scope
Related skills

More from heyvhuang/ship-faster

Installs
53
GitHub Stars
338
First Seen
Feb 10, 2026