docs-review

Cross-check documentation against codebase and review checklist to produce a structured remediation plan.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/Grupo-AFAL/claude-plugins --skill docs-review-grupo-afal
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-review
Source: https://github.com/Grupo-AFAL/claude-plugins/tree/main/docs-tools/skills/docs-review
Command: npx skills add https://github.com/Grupo-AFAL/claude-plugins --skill docs-review-grupo-afal

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Reviews existing documentation to ensure accuracy against the codebase, appropriateness for the target audience, and proper structural organization, reducing release risks and post-release rewrites.

Core Features & Use Cases

  • Systematically inventories pages and sections to verify alignment with code and APIs.
  • Checks audience suitability, terminology, and structure using the provided review checklist.
  • Generates a prioritized remediation plan with suggested edits and a final validation pass.
  • Use Case: A documentation site for Astro Starlight requires a health check before a major release to ensure all pages reflect current code behavior.

Quick Start

Provide the docs URL or repository path and run the docs-review workflow to generate a structured review report.

Frequently Asked Questions about docs-review

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

FAQPage Schema
How to verify documentation accuracy against APIs systematically?

Verifying documentation accuracy against APIs systematically involves inventorying pages and sections to check alignment with current code behavior. This process identifies quality issues and outputs a structured report with actionable fixes.

How do I audit documentation accuracy against a codebase before a release?

To audit documentation accuracy, you can cross-check existing pages and sections against the codebase and APIs. This process inventories content to verify alignment with current code behavior and generates a structured report with actionable fixes.

What is the best way to perform a documentation health check for an Astro Starlight site?

Performing a documentation health check for an Astro Starlight site involves systematically verifying alignment with source code, checking audience suitability, and evaluating structural consistency. This yields a prioritized remediation plan with suggested edits.

How does a documentation review checklist improve content quality?

A documentation review checklist improves content quality by systematically evaluating terminology, audience appropriateness, and structural organization. It cross-references docs with source code to identify discrepancies and produces a final validation pass.

Can I generate a prioritized remediation plan for outdated technical docs?

Yes, you can generate a prioritized remediation plan for outdated technical docs by cross-checking content against the source code. The process identifies accuracy issues and outputs a structured report detailing actionable fixes.

What do I need to provide to start a docs review workflow?

To start a docs review workflow, you need to provide the documentation site URL or the repository path. The workflow then analyzes the content against the codebase to produce a structured review report.