doc-review

Scan documentation for staleness and generate cleanup reports.

182|33|Updated Feb 1, 2026
One-click install
npx skills add https://github.com/YougLin-dev/Aha-Loop --skill doc-review-youglin-dev
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-review
Source: https://github.com/YougLin-dev/Aha-Loop/tree/main/.agents/skills/doc-review
Command: npx skills add https://github.com/YougLin-dev/Aha-Loop --skill doc-review-youglin-dev

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill helps maintain documentation quality by automatically identifying stale or outdated docs, ensuring accuracy and relevance across the project.

Core Features & Use Cases

  • Documentation health monitoring: Scan and report on staleness, outdated references, broken links, and version drift.
  • Automated cleanup planning: Generate actionable cleanup reports and optional fixes using a script-driven workflow.
  • Use Case: Run a monthly docs health check to produce a report and apply safe auto-fixes.

Quick Start

Run the doc-review skill to scan the repository and generate a health report. Then review the auto-fix suggestions or apply them with the cleanup script.

Frequently Asked Questions about doc-review

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

FAQPage Schema
How do I identify and clean stale or outdated documentation across my project?

A documentation health check scans your project to detect staleness, outdated references, broken links, and version drift. It generates an actionable health report and applies script-assisted auto-fixes to resolve discovered documentation issues.

What is the best way to automate a documentation cleanup workflow during maintenance milestones?

Automating documentation cleanup during maintenance milestones requires a repeatable review workflow. This involves running scan scripts to generate health reports and applying automated fixes to ensure documentation accuracy and relevance across the project.

Can I automatically generate a documentation health report and apply safe fixes?

Yes, you can generate a documentation health report and apply safe fixes automatically. The script-driven workflow scans your repository for version drift and broken links, producing actionable cleanup plans with optional auto-fixes for review.

Does this documentation review workflow support scheduled audits and onboarding?

Yes, the documentation review workflow supports scheduled audits and onboarding. It applies a repeatable review process to ensure documentation health, making it suitable for regular maintenance milestones and new team member integration.

What specific documentation issues does an automated staleness report detect?

An automated staleness report detects several documentation issues including content staleness, outdated references, broken links, and version drift. It scans the repository to provide a comprehensive health overview for maintenance.