doc-freshness-review

Audit repository documentation for drift, stale statements, and broken references.

1.1k|133|Updated May 23, 2025

Search Tags:#quality assurance #documentation #audit #readme #maintenance #drift

Ready to run

npx skills add https://github.com/TencentCloudBase/CloudBase-AI-Toolkit --skill doc-freshness-review

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: doc-freshness-review
Source: https://github.com/TencentCloudBase/CloudBase-AI-Toolkit/tree/main/skills/doc-freshness-review
Command: npx skills add https://github.com/TencentCloudBase/CloudBase-AI-Toolkit --skill doc-freshness-review

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the common issue of documentation drift, where READMEs and project docs become outdated compared to the actual codebase, scripts, and workflows.

Core Features & Use Cases

Drift Detection: Identifies stale statements, broken references, and outdated commands across documentation surfaces.
Evidence-Based Auditing: Compares documentation against current repository implementation and generated artifacts.
Use Case: Before a major release, use this skill to ensure that all installation instructions in the README and the doc/ directory accurately reflect the current project structure and available scripts.

Quick Start

Use the doc-freshness-review skill to audit the current repository documentation for stale references and drift.

Frequently Asked Questions about doc-freshness-review

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

FAQPage Schema

How do I detect documentation drift in a repository?▼

Detect documentation drift by comparing prose against current code and file structures to identify stale statements, broken references, and outdated commands across all documented surfaces.

What is the best way to audit a README for broken references and outdated commands?▼

Audit a README for broken references by systematically verifying file paths, command validity, and workflow existence against the current project implementation and generated artifacts.

Can I check documentation directories for stale statements before a major release?▼

Yes, you can audit documentation directories for stale statements before a major release to ensure installation instructions and workflows accurately reflect the current project structure and available scripts.

How do I verify file paths and workflow existence across documented surfaces?▼

Verify file paths and workflow existence by applying evidence-based auditing against current repository implementation to ensure alignment between documentation directories and actual project artifacts.

When should I perform a documentation audit for maintenance?▼

Perform a documentation audit during periodic maintenance to ensure alignment with project implementation, particularly before major releases to verify file structures, scripts, and workflows match the documentation.