documentation-review

Review draft documentation for voice, structure, completeness, and accuracy.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/withmartian-sandbox-darkside/ghrc-y-3126672651424eddb640ecc81321a665 --skill documentation-review-withmartian-sandbox-darkside
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-review
Source: https://github.com/withmartian-sandbox-darkside/ghrc-y-3126672651424eddb640ecc81321a665/tree/main/tw-team/skills/documentation-review
Command: npx skills add https://github.com/withmartian-sandbox-darkside/ghrc-y-3126672651424eddb640ecc81321a665 --skill documentation-review-withmartian-sandbox-darkside

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation quality is often inconsistent, making it hard for users to understand and trust content. This skill provides a structured review process to enforce voice, structure, completeness, and accuracy across documentation.

Core Features & Use Cases

  • Systematic Voice & Tone Review
  • Structural and navigational checks
  • Completeness and accuracy verification
  • Pre-publication quality audit for API/docs and internal guides
  • Collaboration-ready review outputs with remediation suggestions

Quick Start

Run a documentation review on the draft to surface voice, structure, completeness, and accuracy issues.

Frequently Asked Questions about documentation-review

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

FAQPage Schema
How do I run a structured documentation review for pre-publication quality checks?

You can perform a pre-publication quality audit by applying a standardized review checklist to your draft documentation, which verifies voice, structure, completeness, clarity, and technical accuracy while generating remediation suggestions.

What is the best way to check developer docs for style-guide compliance?

Checking developer docs for style-guide compliance involves systematically reviewing voice and tone consistency, structural navigational flow, and technical accuracy against the standard to produce a collaboration-ready review output with recommendations.

How do I verify completeness and accuracy in draft documentation?

Verify completeness and accuracy in draft documentation by running a structured review process that enforces voice, structure, and technical accuracy checks, delivering a standardized output with specific recommendations for remediation.

Can I use a documentation review workflow for internal guides and API docs?

Yes, this documentation review workflow supports internal guides, API documentation, and manuals by enforcing voice, structure, completeness, clarity, and technical accuracy checks, producing a standardized review output with remediation recommendations.

Does a documentation quality audit work for enforcing voice and tone consistency?

Yes, a documentation quality audit systematically reviews voice and tone alongside structure, completeness, clarity, and technical accuracy to enforce consistency, generating a standardized review output with specific remediation recommendations.