documentation-review

Review technical documentation for clarity, accuracy, structure, and agent-readability.

1|Updated Apr 29, 2026

Search Tags:#code review #markdown #technical writing #documentation review #AI-assisted review

Ready to run

npx skills add https://github.com/sigmadigitalza/engineering-playbook --skill documentation-review-sigmadigitalza

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-review
Source: https://github.com/sigmadigitalza/engineering-playbook/tree/main/plugins/sigma-engineering/skills/documentation-review
Command: npx skills add https://github.com/sigmadigitalza/engineering-playbook --skill documentation-review-sigmadigitalza

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the review of technical documentation for clarity, accuracy, structure, and agent-readability, saving time and ensuring high-quality documentation.

Core Features & Use Cases

Automated Review: Reviews technical documentation for clarity, accuracy, structure, and agent-readability.
Customizable Rubric: Applies a customizable rubric for different aspects of documentation.
Voice Preservation: Preserves the author's voice in the documentation.
Use Case: Use this Skill to review a README, design doc, runbook, ADR, contributor guide, or any markdown documentation.

Quick Start

Run the documentation-review skill on the 'README.md' file.

Frequently Asked Questions about documentation-review

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

FAQPage Schema

How do I automate technical documentation review for clarity and accuracy?▼

Automating technical documentation review involves applying a customizable rubric to check markdown files for clarity, accuracy, structure, and agent-readability. This process identifies broken links and outdated information while preserving the author's original voice.

What is agent-readability in technical writing and why does it matter?▼

Agent-readability in technical writing ensures documentation is structured for both human and AI consumption. Reviewing for agent-readability checks that markdown content is clear and accurate enough for automated tools to parse and utilize effectively.

Can I use a customizable rubric to review a README and design docs?▼

Yes, you can apply a customizable rubric to review a README, design doc, runbook, ADR, or contributor guide. The rubric evaluates different aspects of markdown documentation to ensure structure and accuracy without altering the author's voice.

Does automated documentation review preserve the original author's voice?▼

Automated documentation review preserves the original author's voice while checking for issues like broken links and outdated information. It applies a customizable rubric to ensure the markdown content remains clear and accurate without rewriting the text.

What is the best way to check markdown documentation for broken links and outdated information?▼

The best way to check markdown documentation for broken links and outdated information is to run an automated review using a customizable rubric. This process evaluates technical writing for clarity, structure, and agent-readability simultaneously.

What types of markdown files can I review with an AI-assisted documentation tool?▼

You can review any markdown documentation, including a README, design doc, runbook, ADR, or contributor guide. The tool applies a customizable rubric to ensure the technical writing is clear, accurate, and suitable for both human and AI consumption.