Skip to content
OpenAgentSkill
Browsing is open · Catalog captured 2026-11-21 · Automatic updates and account services are paused.
Development

ln-21-documentation-auditor

Audits documentation and code comments for structure, coverage, factual accuracy, and maintainability. Use for documentation trust reviews; not code, test, or architecture audits.

levnikolaevich · AI review on file

Installation

Read the source and dependencies before running a command. Copying does not install or execute anything.

npx skills add levnikolaevich/claude-code-skills --skill ln-21-documentation-auditor

About this skill


name: ln-21-documentation-auditor description: "Audits documentation and code comments for structure, coverage, factual accuracy, and maintainability. Use for documentation trust reviews; not code, test, or architecture audits."

Documentation Auditor

Goal: Audit documentation as a read-only evidence system: can a new contributor, operator, user, or coding agent find the right source, trust its claims, and act without hidden context? Review both standalone documents and code comments where they carry public or operational knowledge.

Execution contract: Treat the ordered checkbox workflow below as this skill's Definition of Done. Track every checkbox as PENDING, then resolve it to PROVEN with concrete evidence, CLEARED with evidence that its conditional trigger is absent, or UNPROVEN; reading, mentioning, delegating, skipping, or tool failure is not proof. Before returning, resolve every PENDING, count only PROVEN and CLEARED items as complete, apply this skill's verdict, decision, and approval rules to every UNPROVEN, and prepend Checklist: X/Y completeIncomplete: None | section/item — reason; outcome impact; exact next action; list every UNPROVEN item.

Tool Routing

NeedPreferred toolUse it whenFallback
Document inventory and hierarchyNative file listing with narrow patternsEstablishing documentation surfaces, generated areas, and navigation structureRepository tree and known entry documents
Links, repeated terms, claims, and contradictionsNative text search, then focused readsFinding references, stale names, duplicated guidance, paths, commands, and configuration keysManual cross-document comparison
Code and configuration truthNative code search, manifests, schemas, and direct file readsA document claims that a path, option, endpoint, behavior, or default existsExecute a safe inspection command when text is insufficient
Freshness and ownershipGit log, blame, and diffDetermining when a claim changed, whether a document tracks active code, or who owns a conventionCurrent code and explicit ownership files
Commands and examplesShell in non-mutating or dry-run modeVerifying help text, command existence, config parsing, generated output, or example syntaxInspect command registration and tests; mark runtime proof unavailable
External factsOfficial documentation, specifications, and release notesA current external API, version, standard, or platform behavior affects correctnessPrimary-source web research; otherwise mark UNVERIFIED

Do not run commands that publish, migrate, deploy, write production state, or rewrite documentation. Generated caches are acceptable only when permitted and disclosed.

Evidence Rules

Claim typeRequired evidence
Repository path, symbol, command, configuration, endpoint, or defaultCurrent repository or safe command output
External API, version, standard, or compatibility statementOfficial source matching the relevant version
Count or coverage statementReproducible query with scope and exclusions
Historical rationaleCurrent decision record or history that still matches implementation
RecommendationA demonstrated reader failure, contradiction, maintenance cost, or operational risk

Absence of documentation is a finding only when a real audience needs the missing knowledge. A stale claim is more serious than a missing optional explanation because it directs readers toward incorrect action.

Checklist

1. Establish Scope and Audiences

  • Identify documentation entrypoints, public docs, maintainer docs, operational runbooks, generated references, examples, and code-comment surfaces in scope.
  • Identify intended audiences and their concrete tasks: understand, install, configure, operate, troubleshoot, extend, or verify the system.
  • Read applicable repository instructions and detect documentation ownership, generation commands, language policy, and source-of-truth conventions.
  • Separate authored documents from generated, vendored, archived, temporary, and example content before scoring defects.
  • Classify each target as entrypoint/index, reference, how-to, explanation, decision record, generated output, or example; prioritize canonical and claim-dense documents before navigation-only files.
  • Define which code, configuration, schemas, tests, and external contracts can verify documentation claims.
  • Keep the audit read-only and record any unavailable source, command, or environment as a limitation.

2. Check Structure and Discoverability

  • Verify that the root entry document explains purpose, supported use, prerequisites, installation path, and navigation appropriate to its audience.
  • Check hierarchy, headings, table of contents, local navigation, cross-links, anchors, and predictable placement of related material.
  • Find broken, redirected, case-sensitive, or repository-relative links and verify that linked files and headings exist.
  • Identify orphan documents, duplicate entrypoints, circular navigation, deep chains, and important content reachable only by repository search.
  • Check that concepts have one canonical owner and that secondary documents link rather than fork rules, thresholds, or procedures.
  • Verify that generated documentation names its generator and does not invite hand editing that will be overwritten.
  • Check whether large documents can be split or compressed without hiding the sequence or context needed to act safely.

3. Check Relevance, Coverage, and Consistency

  • Compare each document's title, scope statement, and intended audience with its actual content.
  • Judge content by document kind: indexes route without duplicating detail, references optimize exact lookup, how-to guides are safely sequenced, explanations build the right mental model, and decisio
Read the complete source ↗