docs-audit

Audit project documentation for drift between code, ADRs, and READMEs.

Updated May 5, 2026
One-click install
npx skills add https://github.com/shakhovskiya-create/shakhoff-claude-marketplace --skill docs-audit-shakhovskiya-create
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-audit
Source: https://github.com/shakhovskiya-create/shakhoff-claude-marketplace/tree/main/plugins/sdlc-audit/skills/docs-audit
Command: npx skills add https://github.com/shakhovskiya-create/shakhoff-claude-marketplace --skill docs-audit-shakhovskiya-create

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation drift and gaps between code, ADRs, and README content undermine project clarity and onboarding.

Core Features & Use Cases

  • Detect drift between documentation and code, including ADR coverage gaps.
  • Assess README quality and consistency across the project.
  • Generate actionable findings and remediation guidance for documentation teams.

Quick Start

Run the docs-audit skill on your repository to generate a drift and ADR coverage findings report.

Frequently Asked Questions about docs-audit

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

FAQPage Schema
How do I detect documentation drift between my code and README files?

Documentation drift is detected by auditing project repositories to identify mismatches between code, README content, and API references. The audit generates structured findings that surface missing or outdated documentation across multiple project sources.

What is ADR coverage gap analysis in software documentation?

ADR coverage gap analysis validates the presence of Architecture Decision Records against actual code changes. It identifies missing ADRs and surfaces outdated architecture documentation to ensure project decisions are accurately recorded.

How do I audit API documentation alignment with code changes?

To audit API documentation alignment, run a documentation audit on your repository to validate API references against code changes. The process produces actionable findings and remediation guidance for misaligned or stale API docs.

Can I assess README quality and consistency across multiple project directories?

README quality is assessed by auditing README sections across project directories to ensure consistency. The audit checks for required sections and identifies outdated content, producing structured drift findings for remediation.

Does the documentation audit work for codebases with multiple documentation sources?

The documentation audit is suitable for codebases with ADRs, architecture decisions, and multiple documentation sources. It evaluates READMEs, docs directories, and API references simultaneously to produce comprehensive drift findings.