docs-guard

Cross-reference documentation claims against source code implementations.

Updated Jun 9, 2026
One-click install
npx skills add https://github.com/Asharf30/Brainwave --skill docs-guard-asharf30
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-guard
Source: https://github.com/Asharf30/Brainwave/tree/main/.agents/skills/docs-guard
Command: npx skills add https://github.com/Asharf30/Brainwave --skill docs-guard-asharf30

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill prevents documentation-code drift by verifying that every claim, code sample, and reference in your documentation is factually supported by the actual codebase, eliminating hallucinations and outdated information.

Core Features & Use Cases

  • Fact Verification: Automatically cross-references symbols, endpoints, and config keys against the source code to ensure they exist and are documented correctly.
  • Code Sample Validation: Ensures all code snippets are syntactically valid, imports resolve, and examples are runnable on a clean machine.
  • Review Mode: Provides a structured audit report flagging false claims, drift, and substance issues in your technical documentation.

Quick Start

Invoke the docs-guard skill to review the current README file for accuracy against the project source code.

Frequently Asked Questions about docs-guard

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

FAQPage Schema
How do I prevent documentation-code drift in my project?

To prevent documentation-code drift, you can cross-reference technical documentation claims against the actual codebase implementation. This systematically validates symbols, endpoints, and behavioral claims to eliminate outdated information and hallucinations.

What is documentation drift detection and when do I need it?

Documentation drift detection is the process of verifying that READMEs, API references, and docstrings match the source code. You need it when technical documentation contains outdated claims, invalid code samples, or references to removed symbols.

Can I verify code samples in my README against my source code?

Yes, you can validate code samples by checking that all snippets are syntactically valid, imports resolve correctly, and examples are runnable. This ensures documentation examples match actual source definitions and configuration keys.

What is the best way to audit technical writing for false claims?

The best way to audit technical writing is to generate a structured review report that flags false claims, drift, and substance issues. This verifies every code reference and API endpoint against the actual codebase for factual accuracy.

Why does my API documentation reference missing endpoints and symbols?

API documentation references missing endpoints and symbols because of documentation-code drift, where updates to the source code are not reflected in the docs. Fact verification cross-references claims against the codebase to identify these mismatches.