review-docs

Review target documentation for style, readability, tone, completeness, and factual accuracy.

49.7k|3.4k|Updated May 9, 2021
One-click install
npx skills add https://github.com/tldraw/tldraw --skill review-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: review-docs
Source: https://github.com/tldraw/tldraw/tree/main/.claude/skills/review-docs
Command: npx skills add https://github.com/tldraw/tldraw --skill review-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams review and improve project documentation through a structured evaluation loop, employing parallel evaluation to surface issues and provide actionable improvements, with state tracking across rounds.

Core Features & Use Cases

  • Parallel evaluation of style and content to surface readability and accuracy issues.
  • State-tracking across rounds to ensure issues are addressed and verified.
  • Iterative improvement loop guided by user feedback with clear acceptance criteria.
  • Use cases include reviewing README, API docs, and developer guides for clarity, correctness, and completeness.

Quick Start

Run the review-docs skill on a target document path to initiate an evaluation and improvement cycle.

Frequently Asked Questions about review-docs

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

FAQPage Schema
How do I review documentation for style and accuracy issues?

To review documentation for style and accuracy issues, you can run a structured evaluation loop on a specified document path. This process employs parallel evaluation to surface readability, tone, completeness, and factual correctness problems.

What is state tracking in iterative document improvement?

State tracking in iterative document improvement is the process of maintaining a state file to log identified issues and guide verification across multiple rounds. It ensures that style and accuracy problems are addressed systematically rather than lost between reviews.

How do I improve developer guide readability and tone?

You can improve developer guide readability and tone by initiating an iterative improvement cycle guided by user feedback. The evaluation operates on your target document to assess style and provide actionable improvements with clear acceptance criteria.

Can I use parallel evaluation for README and API docs review?

Yes, you can use parallel evaluation for README and API docs review. The system evaluates documentation by operating on a specified document path, targeting these specific file types to surface clarity, correctness, and completeness issues.

What's the best way to ensure accuracy in project documentation?

The best way to ensure accuracy in project documentation is through a structured evaluation loop with state tracking across rounds. This verifies that factual correctness issues are identified by parallel agents and resolved to meet clear acceptance criteria.

Are there limitations to iterative documentation review loops?

A limitation of iterative documentation review loops is that they require user feedback to guide the improvement cycle and clear acceptance criteria to conclude. The process evaluates a specified document path and relies on a state file to track issues across rounds.