docs-audit-and-refresh

Audit repository documentation against the current codebase and update stale content.

26.9k|2.8k|Updated Jun 26, 2025
One-click install
npx skills add https://github.com/QwenLM/qwen-code --skill docs-audit-and-refresh
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-audit-and-refresh
Source: https://github.com/QwenLM/qwen-code/tree/main/.qwen/skills/docs-audit-and-refresh
Command: npx skills add https://github.com/QwenLM/qwen-code --skill docs-audit-and-refresh

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the common issue of documentation becoming outdated or incomplete as codebases evolve, ensuring that documentation accurately reflects the current state of the repository.

Core Features & Use Cases

  • Documentation Auditing: Compares docs/ content against the live codebase to identify missing, incorrect, or stale information.
  • Targeted Refresh: Updates specific documentation pages to align with current features, settings, tools, or integrations.
  • Use Case: After a major feature update, use this Skill to quickly scan the documentation, find any pages that no longer match the new functionality, and update them to provide accurate guidance to users.

Quick Start

Review the repository's documentation for any outdated information and update the relevant pages.

Frequently Asked Questions about docs-audit-and-refresh

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I audit repository documentation against the current codebase?

To audit repository documentation, compare the `docs/` content against the live codebase to identify missing, incorrect, or stale information. This process uses repository evidence to ensure developer and user-facing docs accurately reflect current features.

What is the best way to refresh outdated technical documentation after a feature update?

Refreshing outdated technical documentation after a feature update involves scanning the `docs/` directory to find pages that no longer match new functionality. Updates are prioritized based on reader impact and corrected using current repository evidence for accuracy.

Can I update documentation outside the docs directory when syncing with code?

No, documentation updates are limited to the `docs/` directory. The audit identifies stale or incorrect user-facing and developer-facing behavior across the repository, but targeted refreshes and corrections are only applied to files within this specific folder.

How does a documentation refresh prioritize which stale pages to fix first?

A documentation refresh prioritizes fixes based on reader impact, focusing on user-facing and developer-facing behavior. By evaluating repository evidence, it targets the most critical missing or incorrect information to ensure documentation accurately reflects current features.

When do I need to perform a codebase sync for developer docs?

You need a codebase sync for developer docs when codebases evolve and documentation becomes outdated or incomplete. Auditing identifies stale information and missing features, ensuring documentation accurately reflects the current state of the repository.

Does docs-audit-and-refresh work without external dependencies?

Yes, docs-audit-and-refresh operates without external dependencies. It uses the repository's internal references to compare existing `docs/` content against the codebase, identifying and correcting missing or stale information to keep documentation in sync.