doc-reviewer

raiich's avatarfrom raiich

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

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

When & Why to Use This Skill

The Documentation Reviewer is a specialized Claude skill designed to automate the quality assurance of Markdown files. It systematically audits .md documents for naming conventions, conciseness, and structural consistency against predefined style guides, ensuring high-quality technical documentation with actionable fix proposals. By streamlining the editing process, it helps maintain professional standards across large-scale documentation projects.

Use Cases

  • Automated Quality Audit: Perform a comprehensive review of all project documentation before a major release to ensure naming conventions and completeness meet professional standards.
  • Style Guide Enforcement: Automatically validate new or edited Markdown files against internal rules (e.g., .claude/rules/documentation.md) to maintain a unified brand voice and consistent formatting.
  • Content Optimization: Identify wordy or incomplete sections in technical manuals and knowledge bases to improve readability and user experience through specific, line-by-line fix suggestions.
namedoc-reviewer
descriptionReview all .md files for naming conventions, conciseness, consistency, and completeness. Use when creating or editing any markdown file.
allowed-toolsRead, Grep, Glob

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