documentation-review
This tool verifies documentation accuracy, checks link validity, confirms project standard compliance, and creates task lists.
Install
mkdir -p .claude/skills/documentation-review && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/169" && unzip -o skill.zip -d .claude/skills/documentation-review && rm skill.zipInstalls to .claude/skills/documentation-review
Activation
This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.
Reviews documentation for factual accuracyKey capabilities
- →Validate technical claims against actual tool behavior
- →Verify internal link integrity
- →Check documentation examples for syntax correctness
- →Identify typos and formatting inconsistencies
- →Generate actionable remediation todo lists
How it works
It compares text claims against external validation scripts and linked files to build a task-based audit report.
Inputs & outputs
When to use documentation-review
- →Validating technical documentation accuracy
- →Checking documentation for broken links
- →Reviewing documentation examples for technical correctness
About this skill
Documentation Review
Instructions
- Read the documentation you are instructed to review
- Make sure that all claims about how toolhive works are accurate
- Make sure that all examples are based in how toolhive really works, check for formatting, typos and overall accuracy
- Make sure that all links point to existing files and the content of the links matches what it should
Fact-checking claims in the documentation
See CHECKING.md on instructions on how to check claims in the docs.
You have some examples on how to fact-check in EXAMPLES.md
Your report
- Do not suggest inline changes
- Present findings and put each into a todo list. The user will then go through them and review manually
When not to use it
- →Creative writing tasks
- →Non-technical documentation review
Limitations
- →Does not automatically fix errors
- →Relies on external CHECKING.md reference files
How it compares
It focuses on empirical accuracy and reference integrity rather than stylistic or grammar-only editing.
Compared to similar skills
documentation-review side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| documentation-review (this skill) | 11 | 4mo | No flags | Beginner |
| docs-review | 10 | 7mo | No flags | Beginner |
| workthrough | 10 | 8mo | Review | Beginner |
| claude-md-improver | 21 | 6mo | Review | Beginner |
Try saying
Example prompts that trigger this skill in your AI assistant.
More by stacklok
View all by stacklok →You might also like
docs-review
metabase
Review documentation changes for compliance with the Metabase writing style guide. Use when reviewing pull requests, files, or diffs containing documentation markdown files.
workthrough
bear2u
Automatically document all development work and code modifications in a structured workthrough format. Use this skill after completing any development task, bug fix, feature implementation, or code refactoring to create comprehensive documentation.
claude-md-improver
anthropics
Audit and improve CLAUDE.md files in repositories. Use when user asks to check, audit, update, improve, or fix CLAUDE.md files. Scans for all CLAUDE.md files, evaluates quality against templates, outputs quality report, then makes targeted updates. Also use when the user mentions "CLAUDE.md maintenance" or "project memory optimization".
anti-slop
rand
Comprehensive toolkit for detecting and eliminating "AI slop" - generic, low-quality AI-generated patterns in natural language, code, and design. Use when reviewing or improving content quality, preventing generic AI patterns, cleaning up existing content, or enforcing quality standards in writing, code, or design work.
agent-md-refactor
davila7
Refactor bloated AGENTS.md, CLAUDE.md, or similar agent instruction files to follow progressive disclosure principles. Splits monolithic files into organized, linked documentation.
backend-to-frontend-handoff-docs
davila7
Create API handoff documentation for frontend developers. Use when backend work is complete and needs to be documented for frontend integration, or user says 'create handoff', 'document API', 'frontend handoff', or 'API documentation'.