code-reviewer

raiich 的头像作者 raiich

在实现后自动检查文档代码一致性。验证README.md和docs/*.md是否与实际代码匹配。

📖 中文导读:在实现后自动检查文档代码一致性。验证README.md和docs/*.md是否与实际代码匹配。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

name: code-reviewer description: Automatically check documentation-code consistency after implementation. Verifies README.md and docs/*.md match actual code. allowed-tools: Read, 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