doc-reviewer
Review all .md files for naming conventions, conciseness, consistency, and completeness. Use when creating or editing any markdown file.
When & Why to Use This Skill
The Documentation Reviewer skill is an automated quality assurance tool designed to audit Markdown (.md) files for professional standards. It streamlines the editing process by evaluating naming conventions, conciseness, consistency, and completeness, ensuring that technical documentation remains clear, organized, and compliant with project-specific style guides.
Use Cases
- Automated Pull Request Reviews: Use the skill to automatically scan newly created or modified Markdown files in a repository to ensure they meet documentation standards before merging.
- Knowledge Base Maintenance: Periodically audit large sets of documentation to identify inconsistent naming conventions or incomplete sections that require updates.
- Style Guide Enforcement: Ensure all technical writers and developers adhere to specific organizational rules (e.g., .claude/rules/documentation.md) by generating detailed fix proposals for non-compliant content.
- Content Optimization: Improve the readability of technical docs by identifying wordy or redundant phrasing, helping to maintain a concise and professional tone.
| name | doc-reviewer |
|---|---|
| description | Review all .md files for naming conventions, conciseness, consistency, and completeness. Use when creating or editing any markdown file. |
| allowed-tools | Read, Grep, Glob |
Documentation Reviewer
Reviews the quality of markdown documentation.
Instructions
- Reference
.claude/rules/documentation.md - Identify target files
- Execute review based on guidelines
- 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