doc-drift-audit

Detect factual mismatches between markdown documentation and code in a repository.

Updated Oct 19, 2025
One-click install
npx skills add https://github.com/igor1309/skills --skill doc-drift-audit
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-drift-audit
Source: https://github.com/igor1309/skills/tree/main/doc-drift-audit
Command: npx skills add https://github.com/igor1309/skills --skill doc-drift-audit

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill verifies that markdown documentation accurately describes the current codebase by detecting factual mismatches between docs and code. It prevents drift after refactors and ensures readers rely on up-to-date information.

Core Features & Use Cases

  • Strict drift protocol to compare documented names, signatures, paths, and behaviors against the codebase.
  • Identifies removed or renamed parameters, outdated references, and misleading descriptions.
  • Provides non-destructive guidance to locate drift and verify compliance during large refactors or routine maintenance.

Quick Start

Run the drift audit against your repository's Markdown docs to surface factual inaccuracies.

Frequently Asked Questions about doc-drift-audit

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

FAQPage Schema
How do I detect documentation drift between markdown files and my codebase?

Documentation drift occurs when markdown files contain factual mismatches with the codebase, such as removed or renamed parameters, outdated file paths, and misleading feature descriptions that no longer match actual code behavior.

What is the best way to audit README files for outdated code references during a refactor?

Auditing README files during a refactor requires a strict drift-detection protocol that compares documented function names, signatures, and file paths against the actual codebase to surface outdated references and ensure alignment with code behavior.

Can I verify markdown documentation consistency without modifying my repository files?

Yes, you can verify documentation consistency using a non-destructive drift audit that provides guidance to locate factual inaccuracies and verify compliance without modifying any repository files.

How do I find outdated function signatures and file paths in my markdown docs?

You can find outdated function signatures and file paths by running a drift audit that compares documented metadata against the actual codebase to identify removed or renamed parameters and outdated references.

When do I need to run a documentation consistency audit on my codebase?

You should run a documentation consistency audit during large refactors and ongoing maintenance to ensure markdown docs accurately describe the current codebase and prevent drift after code changes.