doc-review

Audit Markdown documentation for gaps, errors, security issues, and SOLID violations.

1|Updated Mar 15, 2026
One-click install
npx skills add https://github.com/kegbi/monica-companion --skill doc-review-kegbi
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-review
Source: https://github.com/kegbi/monica-companion/tree/main/.agents/skills/doc-review
Command: npx skills add https://github.com/kegbi/monica-companion --skill doc-review-kegbi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Audit project documentation to identify gaps, errors, security issues, and architectural or SOLID violations.

Core Features & Use Cases

  • Recursively discover and analyze Markdown docs from a given seed or folder (seed documents include AGENTS.md, README.md, or any index/spec file).
  • Resolve local references to build a connected review scope and surface broken links or unresolved citations.
  • Produce a detailed markdown findings report with file/line evidence saved to context/reviews/.

Quick Start

Invoke /doc-review with a path or seed to start the documentation audit and receive a findings report saved to context/reviews/.

Frequently Asked Questions about doc-review

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

FAQPage Schema
How do I audit project documentation for security issues and architectural violations?

You can identify gaps and errors in project documentation by running a review that resolves local references to build a connected review scope. It surfaces broken links, unresolved citations, and quality issues, saving a detailed report for stakeholder review.

What is the best way to review a folder of Markdown docs for broken links and unresolved citations?

The best way to review a folder of Markdown docs for broken links is to use a tool that expands the local reference graph from a seed document. It resolves local citations to map the connected review scope and flags any unresolved references in the output report.

Can I use a specific seed document like README.md to start a documentation quality review?

Yes, you can use a specific seed document like README.md, AGENTS.md, or any index file to start the review. The process defaults to the context/product/ directory if no path is provided, expanding outward from the seed to discover related files.

Does the documentation audit check for SOLID principle violations in the project specs?

Yes, the documentation audit checks for SOLID principle violations in the project specs. It evaluates the discovered Markdown documents for architectural and SOLID violations, reporting specific file and line evidence in the final markdown findings report.

Where are the findings reports saved after a documentation audit completes?

Findings reports are saved to the context/reviews/ directory after a documentation audit completes. The generated markdown report contains detailed evidence, including file and line numbers, to support stakeholder review and action-oriented workflows.