Agent skill

Audit Docs

by chrisguidry in chrisguidry/docket

As you edit pydocket — change a function body, modify a signature, alter a Lua script, refactor a public method, rewrite a docs section — verify that the docstrings and narrative docs touching that…

Custom licenceAuto-check passedDevelopment

Install Audit Docs

skills CLI
$ npx skills add chrisguidry/docket --skill audit-docs -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install chrisguidry/docket audit-docs --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/chrisguidry/docket.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/audit-docs .claude/skills/audit-docs && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
audit-docs
GitHub stars
149
Token cost
~2.1k tokens
SKILL.md length
1,035 words
Files
1
Skills in repo
2
Repo updated
First seen
Licence
Custom licence

At a glance

As you edit pydocket — change a function body, modify a signature, alter a Lua script, refactor a public method, rewrite a docs section — verify that the docstrings and narrative docs touching that…

  • Works in 4 steps: The item's own docstring. Read it. Does… → Tests that pin the contract. If a test… → Call sites. If a method's docstring says… → …
  • Phrases that mean the user wants the explicit audit-as-deliverable mode include audit the docs
  • SKILL.md covers What counts as "touching" docs, What to check, in order, How to fix and What not to flag, plus 3 more sections
  • Calls uv

What it does

Audit Docs is an agent skill from chrisguidry/docket. As you edit pydocket — change a function body, modify a signature, alter a Lua script, refactor a public method, rewrite a docs section — verify that the docstrings and narrative docs touching that change are still accurate, and fix them in the same edit. This is a habit, not a deliverable. Apply it continuously while working on python/src/docket/, docs/.md, or README.md. Surface findings inline as you make changes; do not produce a separate "audit report" unless the user explicitly asks for one. Trigger phrases…

Its SKILL.md is about 2.1k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Technical documentation. It works with Python, Lua and Redis. The repository describes itself as: docket is a distributed background task system for Python.

When your agent uses it

  • Phrases that mean the user wants the explicit audit-as-deliverable mode include audit the docs
  • Check docstring drift
  • Produce an audit report
  • Are the docs still accurate

Example prompts

  • “audit report”
  • “audit the docs”
  • “check docstring drift”
  • “/audit-docs”

Requirements

  • Python 3

Workflow steps

4 steps, taken from the first numbered list in SKILL.md.

  1. The item's own docstring. Read it. Does it still match what the code does? Watch specifically for
  2. Tests that pin the contract. If a test exists for the changed behavior, the test is the contract. When the docstring and the test…
  3. Call sites. If a method's docstring says it raises an exception but the only caller never inspects the return value, the "raises" claim is…
  4. Narrative docs. Grep docs/*.md and README.md for the symbol you changed. For each hit, read the surrounding section and verify the prose…

What it can do on your machine

Read from SKILL.md and the folder at commit 5d2ccd6. 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:

    • uv

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

  • Network

    No URLs in SKILL.md. Its commands use 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.

Context cost

Audit Docs loads about 2.1k tokens when it runs. Until then it costs about 177 tokens; SKILL.md has 1,035 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~177
When it runs · the whole SKILL.md, loaded when a task matches
~2.1k

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

Auto-check passed

The automated check found no risky patterns in SKILL.md.

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

Its licence (Custom licence) doesn't allow us to republish the file, so here is its outline and opening line. It has 1,035 words (~2,052 tokens).

“The default mode of this skill is integrated, not batch. While you're editing pydocket, watch for changes that could invalidate a docstring or a documentation section, and fix them in the same edit — same commit, same PR. The goal…”

— opening of SKILL.md by chrisguidry, Custom licence
name
audit-docs

Read the full SKILL.md on GitHub

Files

Just SKILL.md in .claude/skills/audit-docs of chrisguidry/docket.

Open the folder on GitHubat commit 5d2ccd6

Compare with similar skills

Audit Docs next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Audit Docs compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Audit Docs this skillchrisguidry/docket149—~2.1kAutomated safety check: PassCustom licence
Backend AI Guidelablup/backend.ai-webui1331 repos~1.8kAutomated safety check: PassLGPL-3.0
Adk Sample Creatorgoogle/adk-python22k—~1.3kAutomated safety check: PassApache-2.0
Crafting Effective Readmescumbucadev/cinemaempoa1465 repos~669Automated safety check: PassGPL-3.0
Acquire Codebase Knowledgegithub/awesome-copilot40k1 repos~2.3kAutomated safety check: PassMIT
Docs Syncredis/node-redis18k—~1.1kAutomated safety check: PassMIT

Similar skills

  • Backend AI Guide

    lablup/backend.ai-webui

    Expert guide for Backend.AI distributed computing platform. An agent skill from lablup/backend.ai-webui.

    133 GitHub starsUsed in 1 repo~1.8k tokens
    Backend & APIsAuto-check passed
  • Adk Sample Creator

    google/adk-python

    Official

    Creates a new sample agent in the ADK Python repository — the sample directory, its agent.py, and its README.md — following the conventions the existing samples already use.

    22k GitHub stars~1.3k tokensUpdated today
    DevelopmentAuto-check passed
  • Crafting Effective Readmes

    cumbucadev/cinemaempoa

    A skill your agent uses when writing or improving README files.

    146 GitHub starsUsed in 5 repos~669 tokens
    DevelopmentAuto-check passed
  • Acquire Codebase Knowledge

    github/awesome-copilot

    Official

    Maps an unfamiliar codebase into seven evidence-backed documents in docs/codebase/, using a scan script and templates, for onboarding or architecture write-ups.

    40k GitHub starsUsed in 1 repo~2.3k tokens
    DevelopmentAuto-check passed
  • Docs Sync

    redis/node-redis

    Official

    Analyze master branch implementation and configuration to find missing, incorrect, or outdated documentation in docs/, README.md, and per-package READMEs.

    18k GitHub stars~1.1k tokensUpdated yesterday
    DevelopmentAuto-check passed
  • Docs Conventions

    flet-dev/flet

    A skill your agent uses when writing or reviewing Flet documentation, including Python docstrings (Google style, reST roles, admonitions), Markdown docs (cross-references, images, code examples)…

    17k GitHub stars~1.6k tokensUpdated today
    DevelopmentAuto-check passed

More from chrisguidry/docket

  • Release

    chrisguidry/docket

    How docket tags and publishes a release of pydocket or docket-rs - the tag formats, the docket-rs version bump that must merge first, the release-name format, the gh commands, and what to do when a…

    149 GitHub stars~1.4k tokensUpdated today
    Auto-check passed

Works with

Categories

Questions about Audit Docs

What does Audit Docs do?

As you edit pydocket — change a function body, modify a signature, alter a Lua script, refactor a public method, rewrite a docs section — verify that the docstrings and narrative docs touching that…. Audit Docs is an agent skill from chrisguidry/docket. As you edit pydocket — change a function body, modify a signature, alter a Lua script, refactor a public method, rewrite a docs section — verify that the docstrings and narrative docs touching that change are still accurate, and fix them in the same edit.

When should I use Audit Docs?

Audit Docs fits situations like: phrases that mean the user wants the explicit audit-as-deliverable mode include audit the docs; check docstring drift; produce an audit report; are the docs still accurate.

How do I install Audit Docs in Claude Code?

Run `npx skills add chrisguidry/docket --skill audit-docs -a claude-code`. Or copy the skill folder (.claude/skills/audit-docs in chrisguidry/docket) into .claude/skills/audit-docs in your project. Claude Code loads it when a task matches its description.

How do I install Audit Docs in Codex?

Run `npx skills add chrisguidry/docket --skill audit-docs -a codex`. Or copy the skill folder (.claude/skills/audit-docs in chrisguidry/docket) into .agents/skills/audit-docs in your project. Codex loads it when a task matches its description.

Can I use Audit Docs in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add chrisguidry/docket --skill audit-docs -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/audit-docs, .gemini/skills/audit-docs, .github/skills/audit-docs and .opencode/skills/audit-docs in your project.

What does Audit Docs need to run?

Going by SKILL.md and its folder, Audit Docs needs the command-line tools its instructions call (uv). Our summary lists: Python 3.

Does Audit Docs access the network?

SKILL.md contains no URLs. Its commands use uv, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Audit Docs safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Audit Docs use?

Audit Docs has a licence file (the repository's licence) that doesn't match a standard licence. Read it on GitHub before reusing the skill.

How many tokens does Audit Docs use?

About 2.1k tokens (SKILL.md is roughly 8.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Audit Docs?

Skills that share tags, products or a category with Audit Docs: Backend AI Guide (lablup/backend.ai-webui, 133 stars), Adk Sample Creator (google/adk-python, 22k stars), Crafting Effective Readmes (cumbucadev/cinemaempoa, 146 stars) and Acquire Codebase Knowledge (github/awesome-copilot, 40k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Audit Docs?

chrisguidry (a GitHub user) maintains it in chrisguidry/docket, which has 149 GitHub stars. The repository holds 2 skills in this directory. The repository was last updated on October 7, 2026.

Source: chrisguidry/docket on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.