doc-completeness-audit

doc-completeness-audit is a skill for Claude Code, Codex from NickCrew/Claude-Cortex. It costs 57 tokens per session (3,169 once invoked), scanned A, original, MIT.

A documentation audit that compares what a project should explain with what its documentation actually covers. It produces a prioritized report of missing topics.

In plain words
What is it for?
Checking documentation coverage after shipping features, preparing for releases, and investigating reports that information is hard to find.
Why use it?
It reveals undocumented features, APIs, commands, or settings that users may need, especially after feature work or before a release.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

Good fit Checking documentation coverage after shipping features, preparing for releases, and investigating reports that information is hard to find.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/nickcrew/claude-cortex/doc-completeness-audit
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add NickCrew/Claude-Cortex --skill doc-completeness-audit
Clone the repo
git clone --depth 1 https://github.com/NickCrew/Claude-Cortex

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for doc-completeness-audit

README.md
[![agentmods](https://agentmods.dev/badge/skills/nickcrew/claude-cortex/doc-completeness-audit/github.svg)](https://agentmods.dev/skills/nickcrew/claude-cortex/doc-completeness-audit)
Your own site
<a href="https://agentmods.dev/skills/nickcrew/claude-cortex/doc-completeness-audit"><img src="https://agentmods.dev/badge/skills/nickcrew/claude-cortex/doc-completeness-audit/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for doc-completeness-audit

Your own site · 80×15
<a href="https://agentmods.dev/skills/nickcrew/claude-cortex/doc-completeness-audit"><img src="https://agentmods.dev/badge/skills/nickcrew/claude-cortex/doc-completeness-audit.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 57 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 3,169 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00057 $0.03169
Opus 5.5 $0.00023 $0.01268
Sonnet 5.5 $0.00011 $0.00634
Haiku 4.5 $0.00006 $0.00317

Measured 2mo ago against content hash a865a2e46c84, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

doc-completeness-audit scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2mo ago.

The scan reads SKILL.md. This mod also ships 1 executable file (scripts/inventory.py), listed below but not scanned — reading those needs a real analyzer, not pattern matching.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

skills/doc-completeness-audit/SKILL.md · 399 lines

How it starts

The opening of the file, as written. The whole thing — 399 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Documentation Completeness Audit

Determine whether a documentation set covers everything it should by building an inventory of what needs documenting and comparing it to what exists. The output is a prioritized gap report — not new documentation.

When to Use

  • After shipping a feature — verify docs cover the new surface area
  • Before a release — ensure no undocumented public APIs, CLI flags, or config options
  • When users or new hires report "I couldn't find docs for X"
  • Periodic health check on doc coverage
  • After running doc-maintenance (structural) and doc-claim-validator (accuracy) to go wider

Quick Reference

Resource Purpose Load when
references/coverage-model.md Defines what "complete" means per doc type Always (Phase 1)

Workflow Overview

Phase 1: Inventory   → Build the "should exist" list from code and config
Phase 2: Map         → Match inventory items to existing documentation
Phase 3: Classify    → Score each gap by audience impact
Phase 4: Report      → Produce the prioritized gap report

Phase 1: Build the Inventory

Construct a list of everything that should be documented. Use four sources, checking all of them:

Source 1: Public Code Surface

Run the bundled inventory script to extract documentable surface area deterministically:

python3 skills/doc-completeness-audit/scripts/inventory.py --root . --json > inventory.json

# Or human-readable:
python3 skills/doc-completeness-audit/scripts/inventory.py --root .

# Run specific detectors only:
python3 skills/doc-completeness-audit/scripts/inventory.py --root . --detectors env_vars,cli_commands

The script scans source files across Python, JavaScript/TypeScript, Rust, Go, Ruby, Java, and shell, extracting six categories:

Detector What it extracts
env_vars Environment variable references (os.environ, process.env, env::var, etc.)
cli_commands CLI commands and flags (argparse, click, clap, cobra, commander)
config_keys Configuration key access in config-related files
http_endpoints HTTP route definitions (Flask, FastAPI, Express, Actix, Axum, net/http)
public_exports Public module exports (__init__.py, export, pub fn, Go capitalized funcs)
error_types Custom error/exception class definitions
Event types, webhooks, callbacks Every event name and payload shape

Read the full file on GitHub · 399 lines

Files

What ships with it

2 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2mo ago First seen · 399 lines · 57 tokens per session scan A a865a2e46c84

Subscribe to this mod's changes

doc-completeness-audit is a skill published in the GitHub repository NickCrew/Claude-Cortex (66 stars, last pushed 4mo ago), licensed MIT. It adds 57 tokens to every session and 3,169 once invoked, about $0.0002 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-03.

Related

doc-completeness-audit compared with skills from other repositories

doc-completeness-audit next to 6 skills from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
doc-completeness-auditNickCrew/Claude-CortexSkill664mo agoMITA57Claude Code, Codex
workflow-reviewstencila/stencilaSkill914yesterdayApache-2.0A73Claude Code
agent-reviewstencila/stencilaSkill914yesterdayApache-2.0A57Claude Code
skill-reviewstencila/stencilaSkill914yesterdayApache-2.0A54Claude Code
代码审查员KongFangXun/sofagentSkill553d agoMITA40Claude Code, Codex
silicon-auditorlinkerlin/PUAXSkill3231mo agoMITA39Claude Code, Codex
docs-auditChanningLua/prax-agentSkill2721mo agoMITA30Claude Code