# Review Documentation Consistency

Project documentation often becomes outdated as code changes. This skill compares docs with implementation and produces evidence-based consistency findings.

## Install

```bash
npx skillstore add hylarucoder/doc-consistency-reviewer
```

## Metadata

- Status: approved
- Slug: hylarucoder-doc-consistency-reviewer
- Skillstore revision: r1
- Version status: missing
- Tree hash: dea3087e53b51804ba76ad4bba712f5e7e334f95df153f371093baa26d51f1f7
- Author: hylarucoder
- GitHub username: hylarucoder
- License: MIT
- Repository: https://github.com/hylarucoder/skills-for-vibe-coder/tree/main/skills/doc-consistency-reviewer
- Ref: a06681402992ceae98ba04d54cfd4ab004862696
- Supported tools: Claude, Codex, Claude Code
- Audit status: complete
- Agent install advisory: confirmation\_required
- Manual install advisory: allowed
- Artifact signature: available
- Audit attestation: unavailable
- Human verification: not\_verified
- Risk factors: external\_commands
- Quality score: 38
- Quality tier: warning
- Public page: https://skillstore.pages.dev/skills/hylarucoder-doc-consistency-reviewer
- Manifest: https://skillstore.pages.dev/api/skills/hylarucoder-doc-consistency-reviewer/manifest

## Capabilities

- Compares README and docs content with source code behavior.
- Checks API claims against OpenAPI, proto, GraphQL, or TypeScript contracts.
- Reviews configuration, environment variable, and script documentation for drift.
- Classifies findings by P0 to P3 severity with evidence and impact.
- Produces a documentation consistency report with suggested fixes.

## Use Cases

- Prepare release docs: Audit README and docs before release so published instructions match current behavior.
- Verify API reference: Check endpoint, parameter, and response documentation against implementation contracts.
- Review security claims: Validate documentation about sandboxing, authentication, CORS, or permissions against actual configuration.

## Prompt Templates

### Review README Basics

```
Review README.md against the implementation. List outdated claims, missing features, and commands that do not match the code.
```

### Check API Documentation

```
Compare docs/api.md with the API routes and schema files. Report endpoint, parameter, response, and error-code mismatches.
```

### Audit Configuration Docs

```
Review configuration and environment variable documentation against source code, package scripts, and deployment files. Prioritize issues that break setup.
```

### Run Full Consistency Audit

```
Perform a full documentation consistency audit for README.md, docs, contracts, configs, and security notes. Produce a prioritized report with evidence and fixes.
```

## Limitations

- Does not update documentation automatically unless the user asks for edits.
- Cannot prove behavior that is not represented in code, schemas, configs, or tests.
- Large repositories may require scoped review or parallel agents.
- Findings still need maintainer validation before release decisions.

## Best Practices

- Treat source code, schemas, and configuration as the source of truth.
- Review high-severity findings first, especially security or setup claims.
- Keep each finding tied to exact document and implementation evidence.

## Anti Patterns

- Accepting a documentation claim without locating implementation evidence.
- Mixing speculative concerns with confirmed inconsistencies in one report.
- Ignoring generated docs, API schemas, or package scripts during review.

## Security Audit

- Audited at: 2026-07-06T14:25:30.122\+00:00
- Summary: Static external-command findings are false positives from markdown fences, inline path formatting, and JSON strings. The entropy findings are false positives because the files are readable markdown. Semantic review found an embedded audit output file that claims the skill is safe and all findings are false positives.

## Stats

- Views: 168
- Downloads: 10
- Favorites: 0
- Popularity score: 0