How does the skill handle link validation?

It verifies that links point to existing files and ensures the content at the destination matches the description provided in the documentation text.

What specifically does the skill check for in my docs?

It checks for factual claims about tool behavior, formatting consistency, typographical errors, and whether all internal or external links are valid and relevant.

Does this skill make direct changes to my documentation files?

No, the Documentation Reviewer is designed to present findings as a todo list for manual review rather than making direct inline changes to your files.

Can I use this for non-technical documentation?

While optimized for technical documentation (specifically tools like Toolhive), its logic for checking links, typos, and factual consistency is useful for any structured content.

Is there a way to customize the fact-checking process?

Yes, the skill follows instructions provided in CHECKING.md and EXAMPLES.md within the repository to define how specific claims should be validated.

Documentation Reviewer

Name: Documentation Reviewer
Author: Activer007

byActiver007

学習とドキュメンテーション

Audits technical documentation for factual accuracy, broken links, and consistency with actual software behavior.

概要

The Documentation Reviewer skill is a specialized tool for developers and technical writers who need to ensure their documentation remains reliable and up-to-date. It meticulously cross-references claims made in documentation against the actual functionality of the system, specifically checking for formatting errors, typos, and link integrity. Instead of forcing automated changes, it provides a structured report in the form of a todo list, allowing users to manually verify and implement corrections to maintain high-quality, truthful project guides.

主な機能

Formatting and typo detection
Automated link and internal reference validation
Actionable todo list reporting for manual review
Factual accuracy verification of technical claims
0 GitHub stars
Consistency checking against real-world tool logic

ユースケース

Auditing technical READMEs before software releases
Verifying that tutorial examples match current API behavior
Checking documentation link integrity during repository migrations

概要

主な機能

Formatting and typo detection
Automated link and internal reference validation
Actionable todo list reporting for manual review
Factual accuracy verification of technical claims
0 GitHub stars
Consistency checking against real-world tool logic

ユースケース

Auditing technical READMEs before software releases
Verifying that tutorial examples match current API behavior
Checking documentation link integrity during repository migrations