doc-reviewer

Review Markdown files for naming, conciseness, consistency, and completeness.

1|Updated Oct 31, 2025
One-click install
npx skills add https://github.com/raiich/jumpstarter --skill doc-reviewer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-reviewer
Source: https://github.com/raiich/jumpstarter/tree/main/.claude/skills/doc-reviewer
Command: npx skills add https://github.com/raiich/jumpstarter --skill doc-reviewer

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about doc-reviewer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate markdown documentation quality checks?

Automate markdown quality checks by running this Skill to review all .md files for naming conventions, conciseness, consistency, and completeness. It audits documentation against project guidelines and outputs a structured report with specific issues and recommended fixes without modifying files.

Can I enforce documentation standards across markdown files?

Yes. This Skill enforces documentation standards by referencing project-specific guidelines and checking all .md files for style drift, naming violations, excessive verbosity, and incomplete sections, then reporting violations with line numbers and fix proposals.

What markdown issues does automated documentation review catch?

Automated review catches naming convention violations, excessive verbosity, style inconsistency, incomplete sections, and guideline deviations. It scans all .md files and lists each issue with file names, line references, and actionable recommendations.

How do I reduce manual code review time for documentation?

Run this Skill before committing new documentation or updates to automatically catch quality issues and ensure all markdown meets project standards, eliminating manual review effort and catching errors that lead to inconsistent or incomplete files.

Does this work with project-specific documentation guidelines?

Yes. The Skill references project-specific documentation guidelines—such as files in `.claude/guidelines/documentation.md`—to ensure all markdown content adheres to established standards and organizational conventions.

What output does a markdown quality audit provide?

A markdown audit outputs a detailed structured report listing file names, line numbers, issue descriptions, and specific fix recommendations. The Skill operates read-only and does not modify source files.