Agent skill

Docs Audit and Refresh

by QwenLM in QwenLM/qwen-code

Compares a repository's docs against its current code to find missing, wrong or stale pages, then updates the smallest correct set of files to fix them.

Apache-2.0Auto-check passedDevelopment

Install Docs Audit and Refresh

skills CLI
$ npx skills add QwenLM/qwen-code --skill docs-audit-and-refresh -a claude-code

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

GitHub CLI
$ gh skill install QwenLM/qwen-code docs-audit-and-refresh --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/QwenLM/qwen-code.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.qwen/skills/docs-audit-and-refresh .claude/skills/docs-audit-and-refresh && 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
docs-audit-and-refresh
GitHub stars
28k
Token cost
~942 tokens
SKILL.md length
460 words
Files
2 (incl. references)
Skills in repo
41
Repo updated
First seen
Licence
Apache-2.0

At a glance

Compares a repository's docs against its current code to find missing, wrong or stale pages, then updates the smallest correct set of files to fix them.

  • Works in 5 steps: Build a current-state inventory → Compare implementation against docs/ → Prioritize by reader impact → …
  • Finding documentation that no longer matches the current codebase
  • SKILL.md covers Overview, Workflow, Audit standards and Deliverable
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

The workflow starts by building an inventory of user-facing and developer-facing behavior from the code, tests and configuration, treating the existing docs tree as a map of intended coverage rather than proof it is complete. It then looks for three problems: missing documentation for a real feature, documentation that contradicts the current codebase, and documentation using old names, defaults, paths or examples. A checklist in `references/audit-checklist.md` keeps a broad audit focused on high-signal areas.

Fixes are prioritized by reader impact, starting with broken onboarding or setup flows, then wrong settings or behavior, then entirely missing coverage, and finally clarity improvements. Existing pages are edited before new ones are added, and any new or moved page must be reflected in the nearest `_meta.ts`. Before finishing, the skill checks for leftover old terminology, confirms neighboring pages do not conflict, and verifies that a bundled skill's hardcoded doc-path table, `qc-helper`, still matches the current docs tree.

When your agent uses it

  • Finding documentation that no longer matches the current codebase
  • Auditing docs coverage for a feature, setting or integration
  • Fixing stale examples, paths or defaults across multiple doc pages

Example prompts

  • “Audit docs/ against the current code and list what's missing or wrong.”
  • “Check whether our settings documentation still matches the actual defaults.”
  • “Find stale terminology across the docs and fix the affected pages.”

Workflow steps

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

  1. Build a current-state inventory
  2. Compare implementation against docs/
  3. Prioritize by reader impact
  4. Refresh the docs
  5. Validate the refresh

What it can do on your machine

Read from SKILL.md and the folder at commit 55ee50d. 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

    No scripts in the folder and no shell commands in SKILL.md.

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

  • Network

    No URLs in SKILL.md.

    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

Docs Audit and Refresh loads about 942 tokens when it runs, and up to ~1.6k if it reads all its reference files. Until then it costs about 88 tokens; SKILL.md has 460 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~88
When it runs · the whole SKILL.md, loaded when a task matches
~942
With references · SKILL.md plus every file in references/, read only if the agent opens them
~1.6k

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

The full file from QwenLM/qwen-code at commit 55ee50d, republished under its Apache-2.0 licence (© QwenLM). 460 words, ~942 tokens.

Download SKILL.mdSave it as .claude/skills/docs-audit-and-refresh/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.
name
docs-audit-and-refresh
description
Audit the repository's docs/ content against the current codebase, find missing, incorrect, or stale documentation, and refresh the affected pages. Use when the user asks to review docs coverage, find outdated docs, compare docs with the current repo, or fix documentation drift across features, settings, tools, or integrations.

Docs Audit And Refresh

Overview

Audit docs/ from the repository outward: inspect the current implementation, identify documentation gaps or inaccuracies, and update the relevant pages. Keep the work inside docs/ and treat code, tests, and current configuration surfaces as the authoritative source.

Read references/audit-checklist.md before a broad audit so the scan stays focused on high-signal areas.

Workflow

1. Build a current-state inventory

Inspect the repository areas that define user-facing or developer-facing behavior.

  • Read the relevant code, tests, schemas, and package surfaces.
  • Focus on shipped behavior, stable configuration, exposed commands, integrations, and developer workflows.
  • Use the existing docs tree as a map of intended coverage, not as proof that coverage is complete.
2. Compare implementation against docs/

Look for three classes of issues:

  • Missing documentation for an existing feature, setting, tool, or workflow
  • Incorrect documentation that contradicts the current codebase
  • Stale documentation that uses old names, defaults, paths, or examples

Prefer proving a gap with repository evidence before editing. Use current code and tests instead of intuition.

3. Prioritize by reader impact

Fix the highest-cost issues first:

  1. Broken onboarding, setup, auth, installation, or command flows
  2. Wrong settings, defaults, paths, or feature behavior
  3. Entirely missing documentation for a real surface area
  4. Lower-impact clarity or organization improvements
4. Refresh the docs

Update the smallest correct set of pages under docs/.

  • Edit existing pages first
  • Add new pages only for clear, durable gaps
  • Update the nearest _meta.ts when adding or moving pages
  • Keep examples executable and aligned with the current repository structure
  • Remove dead or misleading text instead of layering warnings on top
Show full SKILL.md (197 more words)Show less
5. Validate the refresh

Before finishing:

  • Search docs/ for old terminology and replaced config keys
  • Check neighboring pages for conflicting guidance
  • Confirm new pages appear in the right _meta.ts
  • Re-read critical examples, commands, and paths against code or tests
  • Verify bundled skill doc indices still match the current docs/ tree. The qc-helper bundled skill (packages/core/src/skills/bundled/qc-helper/SKILL.md) maintains a hardcoded table mapping topics to doc file paths. If you added, moved, renamed, or removed a page under docs/users/, that table must be updated to match. Check the Features and Configuration tables in the SKILL.md against the actual files in docs/users/features/ and docs/users/configuration/. Other bundled or project skills may also reference doc paths — search for docs/users/ across .qwen/skills/ and packages/core/src/skills/bundled/ to catch them.

Audit standards

  • Favor breadth-first discovery, then depth on confirmed gaps.
  • Do not rewrite large areas without evidence that they are wrong or missing.
  • Keep README files out of scope for edits; limit changes to docs/.
  • Call out residual gaps if the audit finds issues that are too large to solve in one pass.

Deliverable

Produce a focused docs refresh that makes the current repository more accurate and complete. Summarize the audited surfaces and the concrete pages updated.

© QwenLM, 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

SKILL.md and 1 other file (references) in .qwen/skills/docs-audit-and-refresh of QwenLM/qwen-code.

  • SKILL.md
  • references/audit-checklist.md

Open the folder on GitHubat commit 55ee50d

Compare with similar skills

Docs Audit and Refresh 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.

Docs Audit and Refresh compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Docs Audit and Refresh this skillQwenLM/qwen-code28k—~942Automated safety check: PassApache-2.0
Diagram Designcathrynlavery/diagram-design47k1 repos~7.5kAutomated safety check: PassMIT
Simple Englishmoeru-ai/airi50k2 repos~4.6kAutomated safety check: PassMIT
Doc SyncJetBrains/ideavim10k2 repos~2.6kAutomated safety check: PassMIT
Mailspring App ScreenshotsFoundry376/Mailspring18k—~1.5kAutomated safety check: PassGPL-3.0
Draw.io Diagram StudioAgents365-ai/drawio-skill10k—~2.4kAutomated safety check: NotesMIT

Similar skills

  • Diagram Design

    cathrynlavery/diagram-design

    Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.

    47k GitHub starsUsed in 1 repo~7.5k tokens
    DevelopmentAuto-check passed
  • Simple English

    moeru-ai/airi

    Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.

    50k GitHub starsUsed in 2 repos~4.6k tokens
    DevelopmentAuto-check passed
  • Doc Sync

    JetBrains/ideavim

    Official

    Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.

    10k GitHub starsUsed in 2 repos~2.6k tokens
    DevelopmentAuto-check passed
  • Mailspring App Screenshots

    Foundry376/Mailspring

    Captures screenshots of the running Mailspring dev app for docs, PRs or visual checks by launching it with a debugging port, driving the UI and clipping to an element.

    18k GitHub stars~1.5k tokensUpdated today
    DevelopmentAuto-check passed
  • Draw.io Diagram Studio

    Agents365-ai/drawio-skill

    Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.

    10k GitHub stars~2.4k tokensUpdated 7 days ago
    DevelopmentAuto-check: notes
  • Dark Architecture Diagram Builder

    Cocoon-AI/architecture-diagram-generator

    Creates dark-themed system, cloud, security and network architecture diagrams as self-contained HTML files with inline SVG and CSS.

    7.4k GitHub starsUsed in 1 repo~2.1k tokens
    DevelopmentAuto-check passed

More from QwenLM/qwen-code

All 41 skills in this repo
  • Reproduces a feature from Codex or Claude Code in Qwen Code by running the reference agent under capture, reading the traces, then implementing matching behavior.

    28k GitHub stars~1.5k tokensUpdated today
    Auto-check passed
  • Qwen Code E2E Testing

    QwenLM/qwen-code

    Guides end-to-end testing of the Qwen Code CLI in headless mode with real model calls, MCP test servers and inspection of raw API traffic.

    28k GitHub stars~2.1k tokensUpdated today
    Auto-check passed
  • Scheduled CI skill that scans a repository for small, certain docs, test and code hygiene issues and fixes them on one branch with a commit per finding.

    28k GitHub stars~1.7k tokensUpdated today
    Auto-check passed
  • Builds a rebranded Qwen Code desktop package from the Tauri shell using only a brand id and a logo, with sensible derived defaults.

    28k GitHub stars~2.1k tokensUpdated today
    Auto-check passed
  • Walks through capturing and comparing V8 heap snapshots to find memory leaks in the Qwen Code Node.js CLI, using tmux and the chrome-devtools CLI.

    28k GitHub stars~1.3k tokensUpdated today
    Auto-check passed
  • tmux Real User Testing

    QwenLM/qwen-code

    Drives Qwen Code in a real tmux session the way a user would and saves a readable step-by-step transcript of each screen for maintainers to review.

    28k GitHub stars~2.3k tokensUpdated today
    Auto-check passed

Categories

Questions about Docs Audit and Refresh

What does Docs Audit and Refresh do?

Compares a repository's docs against its current code to find missing, wrong or stale pages, then updates the smallest correct set of files to fix them. The workflow starts by building an inventory of user-facing and developer-facing behavior from the code, tests and configuration, treating the existing docs tree as a map of intended coverage rather than proof it is complete. It then looks for three problems: missing documentation for a real feature, documentation that contradicts the current codebase, and documentation using old names, defaults, paths or examples.

When should I use Docs Audit and Refresh?

Docs Audit and Refresh fits situations like: finding documentation that no longer matches the current codebase; auditing docs coverage for a feature, setting or integration; fixing stale examples, paths or defaults across multiple doc pages.

How do I install Docs Audit and Refresh in Claude Code?

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

How do I install Docs Audit and Refresh in Codex?

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

Can I use Docs Audit and Refresh 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 QwenLM/qwen-code --skill docs-audit-and-refresh -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/docs-audit-and-refresh, .gemini/skills/docs-audit-and-refresh, .github/skills/docs-audit-and-refresh and .opencode/skills/docs-audit-and-refresh in your project.

What does Docs Audit and Refresh need to run?

SKILL.md names no scripts, command-line tools or credentials: Docs Audit and Refresh is instructions for the agent only.

Does Docs Audit and Refresh access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Docs Audit and Refresh 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 Docs Audit and Refresh use?

Docs Audit and Refresh is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Docs Audit and Refresh use?

About 942 tokens (SKILL.md is roughly 3.8k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 624 tokens, read only when the agent opens those files.

What are the alternatives to Docs Audit and Refresh?

Skills that share tags, products or a category with Docs Audit and Refresh: Diagram Design (cathrynlavery/diagram-design, 47k stars), Simple English (moeru-ai/airi, 50k stars), Doc Sync (JetBrains/ideavim, 10k stars) and Mailspring App Screenshots (Foundry376/Mailspring, 18k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Docs Audit and Refresh?

QwenLM (a GitHub organization) maintains it in QwenLM/qwen-code, which has 28,370 GitHub stars. The repository holds 41 skills in this directory. The repository was last updated on October 9, 2026.

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