design-doc-audit

Audit design documents in docs/ against the current codebase for consistency.

1|Updated Feb 12, 2026
One-click install
npx skills add https://github.com/ahrav/Gossip-rs --skill design-doc-audit
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: design-doc-audit
Source: https://github.com/ahrav/Gossip-rs/tree/main/.claude/skills/design-doc-audit
Command: npx skills add https://github.com/ahrav/Gossip-rs --skill design-doc-audit

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill ensures that design documents accurately reflect the current state of the codebase, preventing documentation drift and potential misunderstandings.

Core Features & Use Cases

  • Verifies Claims: Checks specific claims in design documents against actual source code.
  • Identifies Drift: Detects discrepancies, stale information, and missing documentation coverage.
  • Use Case: Before merging a significant code change, use this Skill to automatically audit the relevant design documents and ensure they are up-to-date with the new code, flagging any inconsistencies.

Quick Start

Run the design doc audit skill for the coordination scope.

Frequently Asked Questions about design-doc-audit

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

FAQPage Schema
How do I check if design documents match the current codebase?

You can check if design documents match the current codebase by running an audit that verifies consistency and identifies drift in file inventories, type/API accuracy, and behavioral claims.

What is documentation drift detection in software engineering?

Documentation drift detection is the process of identifying discrepancies and stale information in design documents by verifying specific architectural claims against the actual source code. This prevents misunderstandings before code merges.

How do I audit a design doc against source code for a specific domain?

You can audit a design doc against source code for a specific domain by running the consistency check in a domain-scoped mode. This targets the audit to relevant sections rather than scanning the entire project.

Can I verify behavioral claims in documentation against actual code?

Yes, you can verify behavioral claims in documentation against actual code. The audit process specifically checks architectural statements and behavioral claims to ensure your docs accurately reflect the implemented logic.

What is the best way to find missing documentation coverage after code changes?

The best way to find missing documentation coverage is to run a full audit using parallel specialist agents. This identifies discrepancies and stale information, flagging any inconsistencies between new code and existing design documents.

Does the design doc audit work with incremental code changes?

Yes, the design doc audit works with incremental code changes. It operates in incremental, full, or domain-scoped modes to verify file inventories and API accuracy, efficiently targeting only the modified code areas.