Agent skill

code-reviewer

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

Stars 163
Forks 31

Install this agent skill to your Project

npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/documents/code-reviewer

SKILL.md

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

Expand your agent's capabilities with these related and highly-rated skills.

Didn't find tool you were looking for?

Be as detailed as possible for better results