document-reviewer

Review documentation for accuracy against code and generate remediation plans.

10|Updated Jul 30, 2022

Search Tags:#git #documentation #markdown #consistency #codebase #quality #review

Ready to run

npx skills add https://github.com/macgregor/homelab --skill document-reviewer-macgregor

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: document-reviewer
Source: https://github.com/macgregor/homelab/tree/main/.claude/skills/document-reviewer
Command: npx skills add https://github.com/macgregor/homelab --skill document-reviewer-macgregor

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Review documentation for accuracy against the current codebase, internal consistency, and writing quality. Use after code changes, refactors, or before releases.

Core Features & Use Cases

Assess documentation accuracy against code and architecture.
Ensure consistency across docs, READMEs, and references.
Generate a concise remediation plan for found issues.

Quick Start

Review the latest committed docs after a code change and surface obvious inconsistencies.

Frequently Asked Questions about document-reviewer

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

FAQPage Schema

How do I check documentation accuracy against my codebase after a refactor?▼

To check documentation accuracy after a codebase refactor, audit project docs and README files to identify inconsistencies and verify references align with the current code and architecture, generating an actionable remediation plan.

What is the best way to ensure consistency across markdown documentation and code references?▼

Ensuring consistency across markdown documentation involves reviewing committed docs to surface inconsistencies, verifying that code references match the current implementation, and enforcing alignment with architecture and release requirements.

When do I need to review project documentation for gaps?▼

You need to review project documentation for gaps after code changes, refactors, or before releases to ensure accuracy against the current codebase, internal consistency, and writing quality across all project references.

Can I use git committed docs to audit project documentation quality?▼

Yes, you can use git committed docs to audit project documentation quality by reviewing the latest committed files after a code change to surface inconsistencies and verify alignment with the current codebase architecture.

Does documentation review work for README files and code references?▼

Documentation review works for README files and code references by assessing accuracy against code and architecture, ensuring consistency across all project documents, and providing a concise remediation plan for identified issues.

What are the limitations of automated documentation consistency checks?▼

Automated documentation consistency checks focus on verifying accuracy against code and alignment with architecture, but limitations include requiring committed markdown docs to review and needing manual execution of the generated remediation plan.