home / skills / microck / ordinary-claude-skills / documentation-review

documentation-review skill

safe

This skill reviews documentation for factual accuracy and alignment with toolhive behavior, identifying discrepancies and ensuring links and examples reflect

npx playbooks add skill microck/ordinary-claude-skills --skill documentation-review

Review the files below or copy the command above to add this skill to your agents.

Files (2)

SKILL.md

844 B

---
name: Documentation review
description: Reviews documentation for factual accuracy
---

# Generating Commit Messages

## Instructions

1. Read the documentation you are instructed to review
2. Make sure that all claims about how toolhive works are accurate
3. Make sure that all examples are based in how toolhive really works, check for formatting, typos and overall accuracy
4. 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](CHECKING.md) on instructions on how to check claims in the docs.

You have some examples on how to fact-check in [EXAMPLES.md](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

Overview

This skill reviews technical documentation for factual accuracy and consistency. It inspects claims about how systems work, validates examples and links, and produces a prioritized todo-style report of issues to fix. The output is a clear checklist rather than inline edits, so maintainers can review and apply changes manually.

How this skill works

The skill reads the target documentation and cross-checks each claim against authoritative sources, system behavior, and existing files. It validates examples for accuracy and formatting, confirms that links point to existing content and that linked content matches the referenced claim. Finally, it compiles findings into discrete todo items grouped by severity and type.

When to use it

Before publishing or releasing documentation to ensure technical claims are correct
When merging documentation contributions from multiple authors
During a documentation audit or quality assurance pass
If documentation references code, configurations, or file paths that may have changed
When onboarding users to verify tutorial accuracy and reproducibility

Best practices

Run the review with up-to-date access to the codebase and live system behavior to validate claims
Prioritize issues by severity: high (misleading/factual errors), medium (broken links/examples), low (formatting/typos)
Include exact reproduction steps for any example that fails validation
Document the authoritative source for each corrected claim so maintainers can verify
Keep todos actionable and scoped to a single change per item

Example use cases

Validate a setup guide that describes system configuration and expected outputs
Check tutorial examples that include commands, code snippets, or expected responses
Audit API documentation to ensure endpoints, parameters, and sample requests are accurate
Verify that internal links in a docs collection point to the correct files and content
Review claims about feature behavior after a code change or release

FAQ

Will the skill make edits directly to the documentation?

No. It produces a todo-style report with findings and recommendations; maintainers review and implement changes manually.

How are link and example checks performed?

Links are resolved to ensure target files exist and content matches references. Examples are executed or inspected against the current system or authoritative sources when possible.