ze-review-docs

Review Ze documentation against the current codebase for accuracy and coverage.

50|2|Updated Mar 27, 2026
One-click install
npx skills add https://github.com/ze-software/ze --skill ze-review-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ze-review-docs
Source: https://github.com/ze-software/ze/tree/main/.codex/skills/ze-review-docs
Command: npx skills add https://github.com/ze-software/ze --skill ze-review-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Ze documentation often drifts from the codebase, causing inaccuracies and incomplete coverage. This skill builds an inventory for the chosen docs scope, checks anchors, links, examples, and terminology, and reports findings for approval before applying fixes.

Core Features & Use Cases

  • Inventory: Build a scope-specific inventory including path, size, last update, and source freshness.
  • Validation: Run mechanical checks for stale anchors, broken internal links, invalid examples, and terminology mismatches.
  • Reporting: Compare documented features to the current codebase and categorize issues as incorrect, stale, incomplete, missing anchors, broken links, or quality problems; require approval before fixes.

Quick Start

Determine the scope of the docs, generate an inventory, run consistency checks, and report findings for review before fixes.

Frequently Asked Questions about ze-review-docs

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

FAQPage Schema
How do I check documentation accuracy against a codebase?

To check documentation accuracy against a codebase, generate a scope-specific inventory and run consistency checks for stale anchors, broken links, invalid examples, and terminology mismatches. The process compares documented features to current code and categorizes issues before fixes.

What is documentation drift and how do I find stale content?

Documentation drift occurs when docs become inaccurate or incomplete relative to the codebase. You find stale content by building an inventory of paths and update dates, then validating anchors, internal links, examples, and terminology to report missing or incorrect features.

How do I validate broken links and anchors in technical documentation?

Validating broken links and anchors in technical documentation requires running mechanical checks against the chosen docs scope. This process identifies broken internal links and missing anchors, categorizing them as quality problems within a findings report for approval.

Can I review a specific section of my architecture or API docs?

Yes, you can target a specific section of architecture or API docs. The review process applies to targeted areas such as guide, wire, config, or plugin docs to generate a focused inventory and run consistency checks on that scope.

What is the best way to audit terminology mismatches in project docs?

The best way to audit terminology mismatches in project docs is to run a factual review against the current codebase. This verification process identifies terminology inconsistencies and categorizes them for approval before applying fixes.

Does the documentation review process apply fixes automatically?

No, the documentation review process does not apply fixes automatically. It generates a findings report categorizing issues as incorrect, stale, or incomplete, and requires explicit approval before any fixes are applied to the documentation.