docs-review

Review documentation for clarity, structure, accuracy, and style issues.

4|3|Updated Jun 5, 2025
One-click install
npx skills add https://github.com/stacklok/docs-website --skill docs-review-stacklok
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-review
Source: https://github.com/stacklok/docs-website/tree/main/.claude/skills/docs-review
Command: npx skills add https://github.com/stacklok/docs-website --skill docs-review-stacklok

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams identify documentation problems that reduce clarity, trust, and usability by applying a technical writing and copyediting review process.

Core Features & Use Cases

  • Editorial Analysis: Reviews documentation for structure, readability, clarity, conciseness, and alignment with style guidelines.
  • Documentation Quality Checks: Identifies information architecture issues, duplicated content, unclear instructions, inaccurate examples, and LLM-generated writing patterns.
  • Use Case: Use this Skill when reviewing a documentation pull request to find actionable improvements before publication.

Quick Start

Review this documentation change for clarity, structure, accuracy, and style issues with specific recommendations.

Frequently Asked Questions about docs-review

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

FAQPage Schema
How do I review documentation for clarity and style consistency before publication?

Reviewing documentation for clarity and style consistency involves applying a technical writing and copyediting process to evaluate structure, readability, and accuracy. It identifies information architecture issues and provides actionable improvement recommendations for publication readiness.

What does a technical writing editorial review cover?

A technical writing editorial review covers structure, readability, clarity, conciseness, and alignment with style guidelines. It systematically evaluates information architecture, style consistency, accuracy, and readability to identify quality issues like duplicated content and unclear instructions.

Can I use this to review a documentation pull request?

Yes, you can review a documentation pull request to find actionable improvements before publication. The editorial analysis identifies clarity, structure, accuracy, and style issues within the proposed changes.

How do I identify LLM-generated writing patterns in documentation?

Identifying LLM-generated writing patterns in documentation requires quality checks that detect unnatural phrasing alongside standard editorial analysis. The review specifically flags these patterns while evaluating information architecture, accuracy, and style consistency.

Does this editorial review work for multi-page documentation sets?

Yes, the editorial review works for multi-page documentation sets requiring editorial analysis. It systematically evaluates information architecture and style consistency across the entire set to identify duplicated content and structural issues.

What's the best way to check technical documentation for information architecture issues?

The best way to check technical documentation for information architecture issues is through a systematic editorial analysis. This process identifies duplicated content, unclear instructions, and inaccurate examples while evaluating overall structure and readability.