skills.rest
B0yZ4kr14
B0yZ4kr14COMMUNITY
Explore all skills by this author →
WebsiteGitHub

docguard-review

Run docguard-cli diagnose, score, and guard to generate severity-ranked markdown documentation reports.

Updated Mar 16, 2026
Search Tags:#consistency#semantic analysis#documentation review#quality assessment#cross-references#docguard#architecture drift
One-click install
npx skills add https://github.com/B0yZ4kr14/OrthoPlus-Enterprise --skill docguard-review-b0yz4kr14
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docguard-review
Source: https://github.com/B0yZ4kr14/OrthoPlus-Enterprise/tree/main/.agent/skills/docguard-review
Command: npx skills add https://github.com/B0yZ4kr14/OrthoPlus-Enterprise --skill docguard-review-b0yz4kr14

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires docguard-cli.

What problem does it solve?

It prevents documentation from silently going stale by performing a read-only, cross-document consistency and quality review that goes beyond formatting checks.

Core Features & Use Cases

  • Cross-document semantic review: Detects terminology conflicts, narrative/intent mismatches, and cross-reference integrity issues across the doc set.
  • Architecture and code alignment checks: Flags documented components that don’t exist in code and code components that aren’t documented in ARCHITECTURE.md.
  • Quality and severity-ranked reporting: Produces a structured findings report with CRITICAL/HIGH/MEDIUM/LOW classification and remediation recommendations.
  • Safety guardrails: Enforces strictly read-only behavior and outputs a report without modifying files.

Quick Start

Ask an AI agent to run docguard-review against your repo’s canonical documentation to generate a severity-ranked report of drift, gaps, and documentation health issues.

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 and semantic inconsistencies in my repository?▼

Detect documentation drift by running a read-only cross-document review that identifies semantic inconsistencies, terminology conflicts, and cross-reference integrity issues across your repository's canonical docs.

What is the best way to check architecture alignment between documentation and code?▼

Architecture alignment checks flag documented components missing from code and undocumented code components in ARCHITECTURE.md, verifying data-model accuracy and preventing architecture drift.

How do I generate a severity-ranked report for documentation health audits?▼

Generate a severity-ranked documentation health report by running diagnostic commands that classify findings as CRITICAL, HIGH, MEDIUM, or LOW, outputting structured markdown with remediation guidance.

Does docguard-review modify files when checking cross-references and test-spec coverage?▼

No, docguard-review enforces strictly read-only behavior during cross-reference and test-spec coverage checks, outputting a structured findings report without modifying any repository artifacts.

Can I use docguard-cli for test-spec coverage checks and cross-reference integrity verification?▼

Yes, docguard-cli supports test-spec coverage checks and cross-reference integrity verification through diagnose, score, and guard commands that enumerate doc artifacts and output structured findings.

Related Skills

Explore More Content & Communication Skills→
B0yZ4kr14B0yZ4kr14

docguard-sync

Sync DocGuard-owned documentation sections with current codebase state.

Community
Intermediate
CAPHTECHCAPHTECH
1

deliverable-check

Verify deliverables against requirements and generate coverage reports with gaps.

Official
Advanced
josuenavarroaguadojosuenavarroaguado

ci-cd-and-automation

Automate GitHub Actions CI/CD pipelines with quality gates and preview deployments.

Community
Advanced
auldsyababuaauldsyababua
6

markdown-validation

Validate Markdown files for syntax, links, and formatting standards.

Community
Advanced