document-reviewer

Review Sandbox API documentation MDX files for quality and AI-readability.

1|1|Updated Nov 11, 2025
One-click install
npx skills add https://github.com/in-co-sandbox/in-co-sandbox-docs --skill document-reviewer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-reviewer
Source: https://github.com/in-co-sandbox/in-co-sandbox-docs/tree/main/ai/skills/document-reviewer
Command: npx skills add https://github.com/in-co-sandbox/in-co-sandbox-docs --skill document-reviewer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the challenge of creating high-quality, consistent, and AI-readable documentation by providing a structured review process and checklist.

Core Features & Use Cases

  • Quality Auditing: Evaluates documentation across ten key dimensions (Readability, Helpfulness, AI-nativeness, etc.).
  • Consistency Checks: Ensures adherence to writing standards, component usage, and linking requirements.
  • AI-Readability Validation: Verifies that content is self-contained and front-loads key information for LLMs.
  • Use Case: A technical writer needs to ensure a newly created API reference page meets all internal documentation standards before publication. They use this Skill to perform a comprehensive audit.

Quick Start

Use the document reviewer skill to audit the documentation page located at /guides/authentication.mdx.

Frequently Asked Questions about document-reviewer

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

FAQPage Schema
How do I audit API documentation for quality and AI-readability?

To audit API documentation for quality and AI-readability, review MDX files in api-reference, guides, and recipes directories against ten dimensions including readability, helpfulness, and AI-nativeness to receive actionable feedback.

What is AI-readability in technical writing and how does it affect documentation quality?

AI-readability in technical writing ensures content is self-contained and front-loads key information for LLMs. Validating documentation for AI-readability improves content quality by making it easier for AI systems to parse and utilize.

How do I check if my MDX documentation meets consistency standards before publication?

You can check if MDX documentation meets consistency standards by validating content against writing standards, component usage, and linking requirements. This process ensures adherence to internal documentation guidelines before publication.

Can I review documentation quality for guides and recipes directories, not just API reference pages?

Yes, you can review documentation quality for guides and recipes directories, not just API reference pages. The review process evaluates any MDX files within api-reference, guides, and recipes directories against established quality dimensions.

What is the best way to improve technical writing consistency across multiple documentation pages?

The best way to improve technical writing consistency across multiple documentation pages is to apply a structured review process that evaluates readability, helpfulness, and AI-nativeness while enforcing writing standards and component usage.