gza-docs-review

Review project documentation for completeness and consistency against implementation.

11|1|Updated Jan 6, 2026
One-click install
npx skills add https://github.com/mhawthorne/gza --skill gza-docs-review
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: gza-docs-review
Source: https://github.com/mhawthorne/gza/tree/main/src/gza/skills/gza-docs-review
Command: npx skills add https://github.com/mhawthorne/gza --skill gza-docs-review

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation often contains gaps and inaccuracies that confuse users and slow adoption. This Skill helps identify and bridge those gaps quickly.

Core Features & Use Cases

  • Systematic documentation review for accuracy, completeness, and consistency across core docs (README, Quick Start, Configuration, API references).
  • Gap analysis and templated reporting to guide authors and maintainers in closing missing information and correcting errors.
  • Use Case: Before a release, run a docs review to verify alignment with implementation and user needs, then update docs accordingly.

Quick Start

Run the documentation review process to scan the project docs and generate a findings report.

Frequently Asked Questions about gza-docs-review

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

FAQPage Schema
How do I review project documentation for completeness and gaps before a release?

To review documentation for completeness, run a structured process that discovers core docs, verifies them against the implementation, performs gap analysis, and generates a templated findings report to bridge missing information.

What is documentation gap analysis and how does it improve accuracy?

Documentation gap analysis systematically scans core docs like README and API references to identify missing information and inaccuracies, ensuring documentation remains accurate, complete, and useful for onboarding new users and maintaining adoption.

Can I check documentation consistency across multiple components automatically?

Yes, you can check documentation consistency across multiple components by applying a structured review process that reads project docs, verifies alignment with the implementation, and reports inconsistencies to guide maintainers in correcting errors.

Does the documentation review process work for onboarding new users?

Yes, the documentation review process works for onboarding new users by systematically verifying that Quick Start and Configuration docs are complete, accurate, and aligned with actual implementation and user needs.

What is the best way to maintain up-to-date project docs across multiple components?

The best way to maintain up-to-date project docs is to run systematic reviews that verify documentation against the implementation, perform consistency checks, and generate templated reports to guide authors in closing gaps and correcting errors.