Skip to content

Guide · Agent skill

How to use the Docs Audit And Refresh agent skill

Updated · written with AI from the project's own documentation and checked against our catalogue data

Docs Audit And Refresh is an agent skill that checks a project's docs/ folder against its real code, tests, and settings, then edits the pages that have fallen out of date. It is aimed at maintainers, contributors preparing a docs update, and teams checking that onboarding and settings pages still match the product. After this guide you will know what the skill does, how to install it, how to ask for it in plain language, and how to review its changes before merging.

Docs Audit And RefreshQwenLM/qwen-code · Apache-2.0

Quick start

  1. 1Download and unzip. Download the skill ZIP from this page and unzip it so you have a docs-audit-and-refresh folder containing SKILL.md.
  2. 2Place the skill folder. Move the folder into ~/.claude/skills/ for personal use or into the project's .claude/skills/ folder for one repository.
  3. 3Check the repository layout. Confirm the project has a docs/ folder and that the code, tests, and settings the agent needs to read are in the repository.
  4. 4Ask for an audit in plain language. Open the repository and ask the agent to find outdated docs or check docs coverage against the current code.
  5. 5Let the agent audit and edit. The agent inventories the implementation, compares it with docs/, and edits the smallest set of pages needed.
  6. 6Review the diff. Read each changed page against the code, verify commands and paths, and only then merge.

What is an agent skill?

An agent skill is a folder containing a SKILL.md file and optional reference files. When a skill is installed, an AI agent can load its instructions and follow them when a request matches the skill's description.

This skill is named docs-audit-and-refresh and comes from the QwenLM/qwen-code repository under .qwen/skills/docs-audit-and-refresh. Its licence is Apache-2.0.

What the skill makes the agent do

The agent builds an inventory of the current implementation, then compares it with the documentation in docs/. It looks for three kinds of problems: features, settings, tools, or workflows that are undocumented; pages that contradict the code; and pages that use old names, defaults, paths, or examples.

It prioritises setup, installation, authentication, and command instructions first, then wrong settings and behaviour, then entirely missing sections, then clarity fixes. It edits the smallest set of pages needed and finishes with a summary of what it audited and what it changed.

  • Keeps changes inside docs/ and leaves README files alone
  • Treats code, tests, and current configuration as the authoritative source
  • Calls out residual gaps that are too large to fix in one pass
  • Checks that navigation (_meta.ts) and bundled skill doc indexes still match the docs tree

Install the skill from the ZIP

Download the ZIP for this skill from this page and unzip it. Then place the skill folder in one of the locations below. The skill folder should contain SKILL.md at its top level.

For a personal install that applies across your projects, put it in ~/.claude/skills/. For a single project, put it in that project's .claude/skills/ folder. You can also upload the ZIP in the Claude apps under Settings → Capabilities → Skills.

  • Personal: ~/.claude/skills/
  • Per project: .claude/skills/ inside the repository
  • Claude apps: Settings → Capabilities → Skills, then upload the ZIP
~/.claude/skills/

Trigger the skill with natural requests

You do not need a special command. The skill's description says it should be used when you ask to review docs coverage, find outdated docs, compare docs with the current repo, or fix documentation drift across features, settings, tools, or integrations. Asking in those terms is the most reliable way to trigger it.

Run the request from inside the repository you want audited, since the skill reads the code and the docs/ folder there.

  • Review docs coverage for this repo and fix anything missing.
  • Find outdated docs in docs/ and refresh the affected pages.
  • Compare the docs with the current code and tell me what has drifted.
  • Check whether the onboarding and settings pages still match the product.

Review the changes before you merge

The skill edits pages rather than only reporting on them. The source warns that it may rewrite text based on its reading of the code, so treat its output as a draft. Read every changed page against the code yourself, especially commands, flags, paths, and default values.

If you want a report without edits, this skill is the wrong fit. Ask the agent for findings only in your own request, but know that the skill itself is written to make changes.

  • Check every command and path against the repository
  • Confirm new pages appear in the correct _meta.ts navigation
  • Review text that the agent rewrote for accuracy and tone
  • Look for residual gaps the summary reports

What people use it for

  • A maintainer runs an audit after many code changes to catch settings pages that no longer match behaviour.
  • A contributor prepares the docs/ folder before a release by checking installation and command instructions.
  • A team reviews onboarding pages to see whether a new hire would follow steps that still work.
  • Someone renames a setting or tool and asks the agent to find old names and examples across docs/.

Frequently asked questions

Is the Docs Audit And Refresh skill free to use?

The skill is published under the Apache-2.0 licence. The source does not mention any price or paid tier for it.

What do I need to run this skill?

You need a repository with a docs/ folder and code the agent can read. It also needs file access to the repository. The source names no specific API keys or accounts.

Does the skill run scripts or use the network?

According to the skill's listing, it does not run scripts and does not use the network. It works by reading and editing files in the repository.

Where do I put the skill so Claude can find it?

Put the unzipped folder in ~/.claude/skills/ for personal use or in a project's .claude/skills/ folder. You can also upload the ZIP in the Claude apps under Settings → Capabilities → Skills.

Will this work on a project that does not use a docs/ folder?

Probably not well. The skill is scoped to docs/ and was designed around the Qwen Code repository and its docs tree, so projects with documentation elsewhere may not fit its layout.

Can it give me a read-only report instead of editing files?

Not really. The skill is written to edit pages, so it is not a read-only tool. Review its changes carefully before merging, or use a different tool if you only want a report.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

This skill suits maintainers and contributors whose project keeps its documentation in docs/ and who want help catching drift after many code changes. It is a poor fit for projects with docs elsewhere, for anyone who wants a read-only report, or for non-technical users, since it requires reading code and repository structure.

Download the skill