km:doc-review

Review uncommitted documentation diffs for structure, consistency, and factual accuracy.

Updated Jan 24, 2026
One-click install
npx skills add https://github.com/koumatsumoto/agent-config --skill km-doc-review
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: km:doc-review
Source: https://github.com/koumatsumoto/agent-config/tree/main/templates/skills/doc-review
Command: npx skills add https://github.com/koumatsumoto/agent-config --skill km-doc-review

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Reviews uncommitted documentation changes to detect structural issues, cross-document inconsistencies, and factual inaccuracies so that commits do not introduce misleading or fragmented documentation.

Core Features & Use Cases

  • Systematic change classification and full-document reading to ensure partial edits do not break overall structure.
  • Cross-document consistency checks to detect redundant or conflicting information across README, CLAUDE.md, AGENTS.md, and docs/.
  • Primary-source verification guidance to confirm factual claims against repository implementation, configuration files, or external authoritative references.
  • Use case: During a pre-commit review, run the workflow to verify that a README update aligns with installation scripts, does not duplicate a canonical section in CLAUDE.md, and that any command examples match actual help output.

Quick Start

Review the staged documentation changes with a structured checklist focusing on structure, inter-document consistency, and factual verification.

Frequently Asked Questions about km:doc-review

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

FAQPage Schema
How do I review uncommitted documentation changes for consistency and accuracy?

Reviewing uncommitted documentation changes involves reading staged git diffs to classify edits, checking cross-document alignment across READMEs and guides, and verifying factual claims against implementation sources to prevent misleading commits.

Can I check cross-document consistency between README and configuration files during a pre-commit review?

Checking cross-document consistency during a pre-commit review compares staged documentation changes against files like CLAUDE.md, AGENTS.md, and configuration scripts to detect redundant, conflicting, or fragmented information across the repository.

What is the best way to validate internal links and anchors in markdown documentation before committing?

Validating internal links and anchors in markdown documentation requires reading the changed files and their related documents, then systematically verifying that link targets and anchor references resolve correctly within the repository structure.

How do I fact-check command examples in documentation against actual help output?

Fact-checking command examples involves primary-source verification, comparing the documented commands and claims against the actual repository implementation, configuration files, or authoritative external references to ensure factual accuracy.

Does this documentation review workflow work with partial edits to existing technical guides?

The documentation review workflow handles partial edits by performing full-document reading alongside systematic change classification, ensuring that localized updates do not break the overall structural clarity of the existing technical guide.

Why do partial documentation updates introduce cross-document inconsistencies in a repository?

Partial documentation updates introduce inconsistencies when edits to one file omit corresponding changes in related documents, causing conflicting setup instructions or redundant information across READMEs, specs, and configuration guides.