How does this skill report documentation errors?

It generates a structured report in the form of a todo list rather than making direct inline changes, allowing users to review and apply fixes manually.

Does it check for broken links?

Yes, it verifies that all links in the documentation point to existing files and that the content matches the expected target.

Is this skill limited to specific software like toolhive?

While the default configuration mentions toolhive, the skill's logic is designed to perform factual and structural reviews on any set of technical documents.

Can it verify technical code examples?

Yes, it specifically checks that code examples are based on how the software actually works and identifies formatting or logic errors.

What is the primary benefit of using this over a linter?

Beyond syntax, this skill focuses on the 'truth' of the content, ensuring that documentation claims actually match the software's functional reality.

Documentation Reviewer

Name: Documentation Reviewer
Author: Activer007

byActiver007

콘텐츠 관리

Reviews technical documentation for factual accuracy, validates code examples, and identifies broken links.

소개

Documentation Reviewer is a specialized Claude Code Skill designed to audit technical documentation and ensure it aligns with the actual functionality of the codebase. It meticulously checks factual claims, validates code snippets against real-world behavior, identifies broken links, and flags formatting issues or typos. Instead of making intrusive inline changes, it generates a structured report with a todo list of findings, empowering developers to maintain high-quality, reliable documentation while retaining full manual control over the final edits.

주요 기능

Factual accuracy auditing against real-world tool behavior
Detection of typos and inconsistent formatting standards
Validation of code examples for syntax and functional correctness
Comprehensive link integrity checking for internal and external paths
Non-intrusive reporting via structured todo lists for manual review
0 GitHub stars

사용 사례

Auditing technical documentation before a major software release
Validating tutorial code snippets after significant API changes
Cleaning up broken links and outdated claims in large documentation repos

소개

주요 기능

Factual accuracy auditing against real-world tool behavior
Detection of typos and inconsistent formatting standards
Validation of code examples for syntax and functional correctness
Comprehensive link integrity checking for internal and external paths
Non-intrusive reporting via structured todo lists for manual review
0 GitHub stars

사용 사례

Auditing technical documentation before a major software release
Validating tutorial code snippets after significant API changes
Cleaning up broken links and outdated claims in large documentation repos