ln-21-documentation-auditor

Audits documentation and code comments for structure, coverage, and factual accuracy.

556|83|Updated Oct 24, 2025
One-click install
npx skills add https://github.com/levnikolaevich/claude-code-skills --skill ln-21-documentation-auditor
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ln-21-documentation-auditor
Source: https://github.com/levnikolaevich/claude-code-skills/tree/main/plugins/codebase-audit-suite/skills/ln-21-documentation-auditor
Command: npx skills add https://github.com/levnikolaevich/claude-code-skills --skill ln-21-documentation-auditor

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation drifts out of sync with code, leaving readers with stale commands, broken links, and contradictory guidance. This Skill audits documentation as an evidence system so contributors, operators, and agents can trust what they read.

Core Features & Use Cases

  • Structure and Discoverability Review: Checks entrypoints, hierarchy, links, orphan pages, and canonical ownership of concepts.
  • Fact and Example Verification: Builds a claim ledger of paths, commands, versions, and configuration keys, then verifies each against repository evidence or official external sources.
  • Comment and Docstring Audit: Matches docstrings against actual signatures and flags comments that narrate syntax or promise unimplemented behavior.
  • Use Case: Before a major release, run the audit to produce a verdict report classifying every document as KEEP, ADD, UPDATE, DELETE, or MERGE with prioritized P0-P3 findings.

Quick Start

Audit this repository's documentation and code comments for accuracy and produce a verdict report with prioritized findings.

Frequently Asked Questions about ln-21-documentation-auditor

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

FAQPage Schema
How do I audit documentation for accuracy against code?

Extract material claims about paths, commands, versions, and configuration keys into a claim ledger, then verify each against current repository evidence or safe command output. Use official sources for external APIs and record the exact evidence for every verified or unverified claim.

How to find stale or broken documentation in a repository?

Use text search to find repeated terms, stale names, and broken links, then check git log and blame to determine whether documents track active code. Flag obsolete future-tense plans, removed features, and old directory layouts as findings.

Does the documentation audit modify any files?

No, the audit is strictly read-only. It never runs commands that publish, migrate, deploy, or rewrite documentation, and any unavailable source or command is recorded as a limitation in the report.

What verdicts does a documentation audit report produce?

The report returns PASS, CONCERNS, FAIL, or BLOCKED based on verified claims and findings. FAIL applies to proven unsafe guidance or unresolved P0/P1 issues, while BLOCKED applies when safety-critical claims cannot be verified.

When should I not use a documentation audit skill?

Do not use it for code quality, test coverage, or architecture reviews, which belong to separate audit skills. It also treats missing documentation as a finding only when a real audience needs the missing knowledge.