docs-audit

docs-audit is a skill for Claude Code, Codex from me2resh/apexyard. It costs 35 tokens per session (1,603 once invoked), scanned A, original, MIT.

A review of project documentation using Diátaxis, a method that separates learning tutorials, task-focused how-to guides, factual reference, and explanations. It checks materials such as the README, API documentation, deployment guides, and changelog for missing or outdated information.

In plain words
What is it for?
It is for auditing README files, setup instructions, deployment and troubleshooting guides, API references, configuration details, architecture explanations, and changelogs.
Why use it?
It reveals whether developers can learn the project, complete common tasks, look up details, and understand design decisions without relying on incomplete or stale documentation.

Skill for Claude CodeCodex

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.

agentmods
npx agentmods add skills/me2resh/apexyard/docs-audit
Any agent
npx skills add me2resh/apexyard --skill docs-audit
Clone the repo
git clone --depth 1 https://github.com/me2resh/apexyard

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 docs-audit

README.md
[![agentmods](https://agentmods.dev/badge/skills/me2resh/apexyard/docs-audit.svg)](https://agentmods.dev/skills/me2resh/apexyard/docs-audit)
Your own site
<a href="https://agentmods.dev/skills/me2resh/apexyard/docs-audit"><img src="https://agentmods.dev/badge/skills/me2resh/apexyard/docs-audit.svg" alt="Measured on agentmods" height="20"></a>
Per session 35 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,603 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
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 $0.00035 $0.01603
Opus 5 $0.00017 $0.00801
Sonnet 5 $0.00007 $0.00321
Haiku 4.5 $0.00003 $0.00160

Measured 5d ago against content hash 9290e9a77b70, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

docs-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 5d ago.

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.

.claude/skills/docs-audit/SKILL.md · 139 lines

How it starts

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

/docs-audit — Documentation Completeness (Diataxis)

Deep-dive documentation analysis using the Diataxis framework. Checks that docs cover all four quadrants (tutorials, how-to guides, reference, explanation) and are not stale. Invoke when /launch-check's documentation row shows WARN or FAIL.

Diataxis Framework

Quadrant Purpose What to look for
Tutorials Learning-oriented, guided first steps Getting started guide, quickstart, "Hello World"
How-to guides Goal-oriented, solving specific problems Deployment guide, migration guide, troubleshooting
Reference Information-oriented, accurate description API docs, config reference, CLI flags, environment variables
Explanation Understanding-oriented, why things work Architecture overview, design decisions (AgDRs), ADRs

Process

Step 1: README quality

Check README.md for these sections (each is pass/fail):

Section Present? Quality check
Project description One paragraph explaining what this is and who it's for
Prerequisites Language version, tools needed, accounts required
Quick start Copy-pasteable commands to get running locally in < 5 minutes
Development setup How to set up the dev environment, run tests, lint
Deployment How to deploy to staging and production
Contributing How to contribute (branch naming, PR process, code standards)
License License type and link

Step 2: API documentation (if applicable)

  • Check for OpenAPI / Swagger spec (openapi.yaml, swagger.json)
  • Check for auto-generated docs (Swagger UI, Redoc, tsdoc, typedoc)
  • Check if endpoints in the code match the spec (any undocumented endpoints?)
  • Check for example requests and responses

Step 3: Operational docs

  • Deployment guide: how to deploy, what environment variables are needed
  • Runbook: what to do when things go wrong (overlap with /monitoring-audit)
  • Changelog: is there a CHANGELOG.md? Are releases documented?
  • Architecture overview: high-level diagram or description of components
  • AgDRs/ADRs: are technical decisions documented?

Read the full file on GitHub · 139 lines

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. 5d ago First seen · 139 lines · 35 tokens per session scan A 9290e9a77b70

Subscribe to this mod's changes

docs-audit is a skill published in the GitHub repository me2resh/apexyard (499 stars, last pushed today), licensed MIT. It adds 35 tokens to every session and 1,603 once invoked, about $0.0002 per session on Opus 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-08-30.

Related

Other skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

local-ai-agents

Build local-first AI agents that run entirely on a developer workstation with Microsoft Foundry Local and Qwen function-calling models. Covers Small Language Models (SLMs), the OpenAI-compatible local endpoint, sandboxed local tools, local RAG with Chroma, local MCP servers, hybrid cloud/local routing, and the…

microsoft/ai-agents-for-beginners · 200 tokens

chat-pet-sprite-creation

Use when creating or changing VS Code chat pet sprite art, sprite sheets, state animations, eye treatments, Stable/Insiders variants, or pet transitions under src/vs/workbench/contrib/chat/browser/widget/media/chatPet.

microsoft/vscode · 53 tokens

cpu-profile-analysis

Analyze V8/Chrome CPU profiles (.cpuprofile) and DevTools trace files (Trace-.json). Use when: profiling performance, investigating slow functions, comparing code paths, finding bottlenecks, analyzing timeToRequest, understanding call trees from sampling profiler data, analyzing layout/paint/rendering, investigating…

microsoft/vscode · 71 tokens

chronicle

Analyze Copilot session history for standup reports, usage tips, session search, and session reindexing. Use when the user asks for a standup, daily summary, usage tips, workflow recommendations, wants to search or find past sessions by keyword/file/PR, wants to reindex their session store, or asks about deleting…

microsoft/vscode · 72 tokens

babysit-pr

Babysit a GitHub pull request after creation by continuously polling review comments, CI checks/workflow runs, and mergeability state until the PR is merged/closed or user help is required. Diagnose failures, retry likely flaky failures up to 3 times, auto-fix/push branch-related issues when appropriate, and keep…

openai/codex · 114 tokens