Skip to content
Get packs

Docs Audit And Refresh

Audits a repo's docs/ folder against the code and updates stale or missing pages

Source Download skill
Repository
QwenLM/qwen-code
Stars
28,880
Licence
Apache-2.0
Files
2 files

What it does

When installed, the agent compares a project's documentation folder (docs/) with the actual code, tests, and settings, looking for features that are undocumented, pages that contradict the code, and outdated names, defaults, or examples. It then edits the smallest set of docs pages needed to fix these, prioritizing setup and command instructions, and summarizes what it audited and changed. It is designed around the Qwen Code repository and its docs tree, and says to keep changes inside docs/ and leave README files alone.

Great for

  • Maintainers of a project who want to catch documentation drift after many code changes
  • Contributors preparing a docs update before a release
  • Teams reviewing whether onboarding and settings pages still match the product

Skip it if

  • Projects without a docs/ folder or with docs written outside it, since the skill is scoped to docs/ and may not fit the layout
  • Anyone wanting a read-only report: the skill is written to edit pages, so review its changes before merging, as it may rewrite text based on its reading of the code
  • Non-technical users, since it requires reading source code and understanding repository structure

Try asking

  • “Review our docs coverage against the current codebase and fix anything outdated”
  • “Find documentation for settings that no longer exist or have changed defaults”
  • “Compare the features docs with the current repo and update the affected pages”
  • “Check whether the bundled qc-helper skill's doc links still match the docs/users tree”
Step-by-step guide: how to use Docs Audit And RefreshInstall, first run, examples, tips and FAQs

Install in 3 steps

  1. 1

    Download the skill

    The ZIP contains the 2 original files, the Apache-2.0 licence and an attribution note.

    docs-audit-and-refresh.zip
  2. 2

    Add it to your agent

    Claude Code (all projects)

    mkdir -p ~/.claude/skills && unzip docs-audit-and-refresh.zip -d ~/.claude/skills/

    Claude Code / Agent SDK (this project only)

    mkdir -p .claude/skills && unzip docs-audit-and-refresh.zip -d .claude/skills/

    Claude apps (web/desktop): Settings → Capabilities → Skills → Upload skill, and choose the ZIP.

  3. 3

    Ask for the task

    No special command needed — the agent reads the skill's description and loads it when your request matches. Try one of the prompts above.

Get better results

  • Name the surfaces to audit (for example, settings or integrations) to keep the scan focused, since the skill favors breadth first and can be large
  • Review every edited docs page against the code before committing, because the agent's changes are based on its interpretation of the source
  • Ask for residual gaps to be listed separately if the audit finds more than one pass can fix

What's inside

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

Redistributed unmodified from QwenLM/qwen-code under the Apache-2.0 licence. The assessment was drafted with AI from the skill's files on 2026-10-29. Skills can instruct your agent to run code — read SKILL.md and any scripts before installing.