docguard-review

Analyze documentation collections for drift, coverage gaps, and broken cross-references.

Updated May 18, 2026
One-click install
npx skills add https://github.com/KamiJeong/tech-bridge-book --skill docguard-review-kamijeong
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docguard-review
Source: https://github.com/KamiJeong/tech-bridge-book/tree/main/.specify/extensions/docguard/skills/docguard-review
Command: npx skills add https://github.com/KamiJeong/tech-bridge-book --skill docguard-review-kamijeong

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill performs read-only documentation health analysis so teams can quickly find drift, broken references, missing coverage, and inconsistencies across their canonical docs before those issues confuse readers or block delivery.

Core Features & Use Cases

  • Cross-document consistency checks: Compares terminology, claims, and references across documentation sets to surface contradictions and gaps.
  • Quality and coverage assessment: Evaluates completeness, clarity, currency, and cross-reference integrity for each document and ranks findings by severity.
  • Use case: A team preparing a release can run this Skill to verify that architecture notes, specs, and supporting docs still tell one coherent story after recent changes.

Quick Start

Ask the Skill to review your documentation set and return a structured report of inconsistencies, coverage gaps, and severity-ranked recommendations.

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 canonical docs and spec-kit artifacts?

Documentation drift is detected through read-only cross-reference audits that compare terminology and claims across document collections to surface semantic misalignment and gaps. This analysis verifies coherence between implementation and supporting files without modifying any content.

What is the best way to audit broken cross-references in a documentation collection?

Auditing broken cross-references requires validating cross-document coherence by inspecting links and dependencies across canonical docs, support files, and specs. The process generates a severity-ranked report detailing integrity issues and coverage gaps without altering the original files.

How do I check terminology consistency across multiple documentation sets before a release?

Terminology consistency is checked by performing cross-document comparisons that identify contradictions and semantic gaps across all documentation sets. This read-only quality assessment evaluates completeness and clarity, returning severity-ranked recommendations to ensure one coherent story.

Does this documentation review process modify my original files during quality assessment?

Documentation review does not modify original files because the quality assessment relies entirely on read-only inspection. It analyzes coverage gaps, broken references, and terminology inconsistencies, returning a structured report of findings ranked by severity without touching the source documents.

When do I need to run a cross-reference audit on my support files?

A cross-reference audit is needed when preparing a release or after recent implementation changes to verify that architecture notes, specs, and support files still align. This read-only analysis surfaces drift, broken references, and coverage gaps before they confuse readers.

What limitations exist when assessing documentation coverage and drift without modifying files?

Assessing documentation drift without modifying files limits the process to read-only inspection and reporting, meaning it cannot automatically fix broken cross-references or rewrite inconsistent terminology. It outputs severity-ranked findings and validation results for manual correction instead.