doc-audit

Audits project documentation against source code for dependency, pattern, and rule discrepancies.

Updated Mar 5, 2026
One-click install
npx skills add https://github.com/hb9397/ai-agent-harness-docs --skill doc-audit-hb9397
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-audit
Source: https://github.com/hb9397/ai-agent-harness-docs/tree/main/plugins/ai-agent-harness/runtime/claude/skills/doc-audit
Command: npx skills add https://github.com/hb9397/ai-agent-harness-docs --skill doc-audit-hb9397

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This skill resolves the common issue of documentation drift, where project instructions, architecture guides, and dependency lists become outdated as code evolves.

Core Features & Use Cases

  • Dependency Audit: Compares actual project dependencies against documentation to identify missing or obsolete libraries.
  • Pattern & Architecture Analysis: Scans recent git history and code patterns to ensure new architectural changes are reflected in project docs.
  • Rule Compliance: Verifies that code adheres to the mandatory rules and prohibitions defined in your project's instruction files.
  • Use Case: Use this before a major release to ensure that your AGENTS.md and CLAUDE.md files accurately describe the current state of your codebase and development rules.

Quick Start

Run the doc-audit skill to analyze the current project and propose updates to align the documentation with the actual code.

Frequently Asked Questions about doc-audit

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

FAQPage Schema
How do I check for documentation drift against my source code?

To check for documentation drift, you can audit project documentation against actual source code to identify discrepancies in dependencies, architectural patterns, and rule compliance across multi-app or single-app repositories.

What is the best way to keep AGENTS.md and CLAUDE.md files in sync with my codebase?

The best way to keep AGENTS.md and CLAUDE.md files in sync is by performing a comprehensive audit that validates instruction files against recent git history and code patterns to detect outdated architectural changes.

How do I verify code compliance with rules defined in project instruction files?

You can verify code compliance by scanning the codebase to ensure it adheres to the mandatory rules and prohibitions defined in your project's instruction files, validating that development rules are actively enforced.

Can I audit dependencies in a multi-app repository structure?

Yes, you can audit dependencies in a multi-app repository structure. The audit compares actual project dependencies against documentation to identify missing or obsolete libraries across both multi-app and single-app setups.

How does automated architectural pattern analysis work for project documentation?

Automated architectural pattern analysis scans recent git history and code patterns to ensure new architectural changes are reflected in project docs, maintaining high-fidelity project context for AI agents.

When should I run a documentation audit before a major release?

You should run a documentation audit before a major release to ensure that your AGENTS.md and CLAUDE.md files accurately describe the current state of your codebase, dependency lists, and development rules.