Agent skill

doc-reviewer

Review all .md files for naming conventions, conciseness, consistency, and completeness. Use when creating or editing any markdown file.

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/doc-reviewer

SKILL.md

Documentation Reviewer

Reviews the quality of markdown documentation.

Instructions

  1. Reference .claude/rules/documentation.md
  2. Identify target files
  3. Execute review based on guidelines
  4. Report with fix proposals when issues are found

Output Format

## Documentation Review Results

### ✓ Compliant
- [item]

### ✗ Needs Fix
- file.md:line_number - issue
  Fix proposal: [specific fix details]

📚 Reference: .claude/rules/documentation.md

Notes

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

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