docguard-review

Analyze canonical docs for drift, coverage gaps, and quality issues.

Updated Mar 18, 2026
One-click install
npx skills add https://github.com/raccioly/coach-gravity --skill docguard-review
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docguard-review
Source: https://github.com/raccioly/coach-gravity/tree/main/.agent/skills/docguard-review
Command: npx skills add https://github.com/raccioly/coach-gravity --skill docguard-review

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Cross-document consistency analysis and quality assessment. Performs read-only analysis across all canonical docs, identifies drift, coverage gaps, and quality issues. Produces a structured report with severity-ranked findings. Modeled after speckit-analyze.

Core Features & Use Cases

  • Read canonical docs in docs-canonical/ and evaluate consistency with code references.
  • Identify drift, coverage gaps, and quality issues; output a structured report highlighting findings by severity.
  • Provide remediation guidance and a report-ready summary for stakeholders.

Quick Start

Analyze the repository's canonical docs to generate a non-mutating quality report.

Frequently Asked Questions about docguard-review

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

FAQPage Schema
How do I detect documentation drift across multiple canonical docs?

Cross-document consistency issues are identified by analyzing the full canonical docs inventory to detect drift, coverage gaps, and quality issues. It operates read-only and produces a severity-ranked report for review, relying on the DocGuard CLI for reporting without changing any source files.

What is the best way to generate a quality assessment report for technical documentation?

A quality assessment report is generated by analyzing canonical docs for consistency issues, drift, and coverage gaps. It produces a report-ready summary with severity-ranked findings and remediation guidance for stakeholders, without modifying the original source files.

Does docguard-review modify my source files when checking cross-document consistency?

No, cross-document consistency checking operates strictly read-only. It evaluates the docs-canonical inventory and relies on the DocGuard CLI for reporting, ensuring no source files are changed during the analysis and report generation process.

Can I assess documentation coverage gaps and cross-references without external dependencies?

Yes, coverage gaps and cross-references are assessed without external dependencies. The Skill analyzes the repository's canonical docs internally, identifies quality issues, and outputs a structured report highlighting findings by severity for stakeholder review.

When do I need to run a cross-document consistency analysis on my repository?

Cross-document consistency analysis is needed when maintaining multiple canonical docs that reference evolving code. Running it identifies drift, coverage gaps, and quality issues early, providing a structured report with remediation guidance before stakeholders review the changes.