code-reviewer

raiich's avatarfrom raiich

Automatically check documentation-code consistency after implementation. Verifies README.md and docs/*.md match actual code.

⭐0stars🔀0forks📁View on GitHub🕐Updated Dec 22, 2025

When & Why to Use This Skill

This Claude skill automates the essential process of documentation-code synchronization. It ensures that technical documentation, such as README.md and project manuals, accurately reflects the actual implementation in the codebase. By identifying discrepancies between described features and executed code, it helps developers maintain high-quality, reliable documentation and prevents 'documentation rot' in software projects.

Use Cases

  • Post-Implementation Verification: Automatically audit the README.md after a feature release to ensure all new functions and benchmarks are correctly documented.
  • Documentation Debt Audit: Scan existing repositories to identify unimplemented features mentioned in docs or undocumented features present in the source code.
  • Technical Accuracy Checks: Verify that specific code identifiers, such as Go benchmark categories and file references, match their descriptions in the docs/ directory.
  • Link and Reference Validation: Ensure all internal documentation links and file paths mentioned in technical guides are valid and consistent with the current file structure.
namecode-reviewer
descriptionAutomatically check documentation-code consistency after implementation. Verifies README.md and docs/*.md match actual code.
allowed-toolsRead, Grep, Glob

Documentation Consistency Checker

Automatically verifies consistency between documentation and implementation after code implementation.

Instructions

  1. Review content described in README.md and docs/*.md
  2. Identify recently edited Go files
  3. Verify the following:
    • Are benchmark categories listed in README.md implemented?
    • Are implemented features documented?
    • Are links in docs/*.md valid?

Output Format

## Documentation Consistency Check Results

### ✓ Consistent
- README.md category descriptions match implementation
- New features are documented

### ✗ Needs Review
- README.md:28 - Described but not implemented: "XXX feature"
- file.go:123 - Implemented but not documented: BenchmarkNewFeature

📚 Reference: README.md, docs/*.md

Notes

  • Use only Read, Grep, Glob (no modifications)
  • Report issues with file_name:line_number
  • Encourage documentation reference