Audit Docs

What it does

When your agent uses it

• : the user wants to audit
• Check documentation coverage
• Find doc gaps after a feature branch
• Verify docs are still current for a subject

Example prompts

• “Use the audit-docs skill to audit internal (dev/) and external (docs/) documentation completeness for a feature, subject, or set of existing docs…”
• “/audit-docs”

Requirements

• Compatibility (from SKILL.md): Requires the Infrahub repository checked out. Commit-range and branch audits additionally require Git history.

Workflow steps

4 steps, taken from the step headings in SKILL.md.

1. 1Gather scope
2. 2Map changes to documentation layers
3. 3Generate the audit report
4. 4Apply fixes

What it can do on your machine

Read from SKILL.md and the folder at commit af1c6c8. It shows what the files ask for, not the result of running them.

• Tool permissions

  Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

  From allowed-tools in the SKILL.md frontmatter.

• Runs code

  Shell commands in SKILL.md call:

  • git
  • uv

  From the folder's file list and the shell code blocks in SKILL.md.

• Network

  No URLs in SKILL.md. Its commands use git and uv, which can reach the network depending on how they are called.

  From URLs in SKILL.md, links to its own repository left out.

• Credentials

  Names no API keys, tokens, secrets or passwords.

  From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

• Compatibility

  Requires the Infrahub repository checked out. Commit-range and branch audits additionally require Git history.

  From compatibility in the SKILL.md frontmatter.

Context cost

Audit Docs loads about 1.5k tokens when it runs. Until then it costs about 146 tokens; SKILL.md has 600 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it

~146

When it runs · the whole SKILL.md, loaded when a task matches

~1.5k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from opsmill/infrahub at commit af1c6c8, republished under its Apache-2.0 licence (© opsmill). 600 words, ~1,501 tokens.

name

audit-docs

description

Audits internal (dev/) and external (docs/) documentation completeness for a feature, subject, or set of existing docs, maps changes indicated by the user, across Infrahub's documentation layers, reports gaps, and optionally applies the fixes. TRIGGER when: the user wants to audit or check documentation coverage, find doc gaps after a feature branch, or verify docs are still current for a subject or specific files. DO NOT TRIGGER when: authoring new documentation from scratch → use the add-docs flow; only linting/formatting Markdown → run `uv run invoke docs.lint`.

compatibility

Requires the Infrahub repository checked out. Commit-range and branch audits additionally require Git history.

argument-hint

<commit-range, branch name, subject, or doc paths to audit>

metadata.version

0.1.0

metadata.author

OpsMill

$ARGUMENTS

## Documentation Audit Report

### Scope
<!-- What was scanned: branch/range, subject, or list of doc files -->

### Changes Summary
<!-- Grouped by area: schema, logic, tests, etc. -->

### Documentation Status

For each document checked:

- **File**: path
- **Status**: Current / Outdated / Missing / N/A
- **Details**: What is good, what is missing

### Gaps Found

For each gap:

- **What is missing**: Description
- **Where**: Which file to update or create
- **Severity**: High / Medium / Low
- **Suggested fix**: Concrete content or edit

### Not Gaps (By Design)

Things that look like gaps but are intentionally absent. This section prevents over-documentation.

Common reasons something is not a gap:

- Feature uses standard mechanisms (GraphQL mutations, UI forms) that do not need a dedicated guide.
- Entity is fully documented within a parent feature's knowledge doc.
- An ADR is unnecessary when the spec already captures design decisions.

© opsmill, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .agents/skills/audit-docs of opsmill/infrahub.

Open the folder on GitHubat commit af1c6c8