What problem does it solve?
Manual review of documentation is time-consuming and prone to human error, leading to inconsistent, incomplete, or poorly formatted markdown files. This Skill automates that process, ensuring high-quality and consistent documentation across your project.
Core Features & Use Cases
- Comprehensive Markdown Review: Automatically checks all
.md files for naming conventions, conciseness, consistency, and completeness.
- Guideline Adherence: References project-specific documentation guidelines (e.g.,
.claude/guidelines/documentation.md) to ensure all content meets established standards.
- Actionable Reports: Provides detailed review results with specific fix proposals, including file and line numbers, making corrections straightforward.
- Use Case: Before committing new documentation or updating existing ones, run this Skill to automatically catch errors and ensure all markdown files meet project standards, significantly reducing manual review time and effort.
Quick Start
Review all markdown files in the current directory for quality and consistency.