What is the purpose of the state file?

It creates a markdown tracker in your scratchpad to record discovered issues, their status, and verification history, preventing the AI from re-discovering the same problems.

How does Review-Docs ensure technical accuracy?

The skill uses a Content Agent that reads your source code to verify that documentation claims, behaviors, and code snippets match the actual implementation.

Will this skill add new sections to my documents?

No. Following specific safety guidelines, it focuses on improving existing content and will flag missing information as 'out of scope' rather than adding it automatically.

Does it support automated formatting?

Yes, the improvement agent automatically runs Prettier on the document after applying fixes to ensure code blocks and text follow your project's formatting rules.

Documentation Reviewer

Name: Documentation Reviewer
Author: tldraw

bytldraw

•

45,372

•

内容管理

Evaluates and improves documentation through parallel style and technical accuracy checks with iterative state tracking.

The Review-Docs skill automates the auditing and refinement of documentation by deploying specialized Style and Content subagents in parallel. It evaluates readability, voice, completeness, and technical accuracy—specifically verifying claims against the actual source code—while maintaining a persistent state file to track issues across multiple rounds. This ensures that every fix is verified and that the documentation remains high-quality, technically sound, and consistent with project-specific writing guides without introducing out-of-scope content.

主要功能

01Parallel evaluation using specialized Style and Content subagents

02Automated Prettier integration for consistent document formatting

03Technical accuracy verification against live source code files

04Persistent state tracking to manage issues across iterative loops

0545,372 GitHub stars

06Metric-based scoring for readability, voice, and completeness

使用场景

01Enforcing consistent voice and style across a large documentation suite

02Auditing technical documentation for drift against the latest codebase changes

03Iteratively fixing and verifying complex documentation bugs and inaccuracies

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add tldraw/tldraw review-docs

For use in Claude.ai and ChatGPT

Download Skill