skillZs
★ LIVE SKILL TAGS ★
>>> LIVE SKILLS INDEX <<<
* OPEN SOURCE *
NO LOGIN, NO TRACKING
※ REAL INSTALL DATA ※
← back to all skills
heyvhuang/ship-faster66 installs

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.

How do I install this agent skill?

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

Is this agent skill safe to install?

  • Gen Agent Trust Hubpass

    The documentation consistency reviewer skill is designed to evaluate project documentation against source code to identify inaccuracies. The analysis confirmed that the skill does not engage in malicious behavior, data exfiltration, or unauthorized command execution. It operates correctly within its intended scope of reading local project files and outputting a consistency report.

  • Socketpass

    No alerts

  • Snykpass

    Risk: LOW · No issues

  • Runlayerwarn

    3/3 files flagged

What does this agent skill do?

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
- README.md (root directory)
- docs/**/*.md (all documentation)
- Contract files: OpenAPI/proto/GraphQL schema/TS types

2. Document-by-Document Review

For each document:

  1. List key claims/commitments/configs/interface items
  2. Search for corresponding implementation in code
  3. Compare differences: missing/renamed/behavior mismatch/default value mismatch
  4. Record issues using template

3. Cross-Check

  • Reverse check documentation from contract files
  • Reverse check documentation from config files

See checklist.md for detailed review checklist.

Severity Levels

LevelDefinitionExample
P0Security issue/serious misleadingDocs say sandbox enabled but code doesn't enable it
P1Core functionality inconsistencyFollowing docs leads to failure
P2Incomplete examples/naming inconsistencyDoesn't directly block usage
P3Wording/formatting/link minor issuesDoesn't affect functionality
Pending EvidenceSuspicious but insufficient evidenceNeeds further investigation

Output Format

See output-format.md for detailed templates.

Single Issue Item

### [Title]
- **Severity**: P0/P1/P2/P3/Pending Evidence
- **Location**: `<file_path>:<line_number>`
- **Evidence**:
  - Documentation: [quote]
  - Code: [quote]
- **Impact**: [Misleading consequences]
- **Suggestion**: [Minimal fix]
- **Related Principle**: Code is truth/Contracts first/Security default tightening/...

Review Conclusion

## Review Conclusion
- **Verdict**: Pass/Conditional Pass/Fail
- **Summary**: P0:x P1:x P2:x P3:x Pending:x
- **Fix Priority**: P0 → P1 → P2 → P3

Multi-Agent Parallel

For acceleration, split by following dimensions for parallel multi-agent execution:

  1. By document type - One agent each for README, API docs, development guide
  2. By module - One agent per functional module's documentation
  3. By check direction - One checks docs against code, another checks code against docs

Deduplication and unified severity rating needed when aggregating.

Execution

After review completion, output doc-consistency.md report file, and also output doc-consistency.json (structured issue list for aggregation/deduplication/statistics).

Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.

<a href="https://skillzs.dev/skills/heyvhuang/ship-faster/review-doc-consistency">View review-doc-consistency on skillZs</a>