Does this skill automatically edit my documentation?

No, this skill is designed to present findings as a todo list report, allowing you to review and apply changes manually to maintain editorial control.

How does it handle broken links?

The skill checks if links point to existing files and verifies that the content of the linked page matches the context of the documentation.

What is the primary benefit of using this skill?

It significantly reduces the risk of shipping inaccurate or broken documentation by automating the tedious process of fact-checking and link verification.

Can it verify code examples within the docs?

Yes, it checks that examples are formatted correctly and reflect the actual functionality of the tools they describe.

Technical Documentation Review

Name: Technical Documentation Review
Author: ovachiever

byovachiever

•

Learning & Documentation

Audits technical documentation for factual accuracy, link integrity, and formatting consistency.

About

The Technical Documentation Review skill provides a rigorous auditing layer for your software guides and manuals. It cross-references technical claims against actual system behavior, ensures code examples are correctly formatted and functional, and validates that all links point to the correct resources. Designed for high-stakes documentation, it identifies typos and inaccuracies without making destructive inline changes, instead providing a structured todo list for human oversight and manual verification.

Key Features

Factual verification of technical claims and system behavior
5 GitHub stars
Link integrity checking for internal and external references
Code example validation for formatting and accuracy
Comprehensive typo and grammatical error detection
Structured reporting via actionable todo lists

Use Cases

Verifying that tutorial code snippets remain functional after updates
Auditing technical manuals before a major software release
Standardizing link references and formatting across large docsets

About

Key Features

Factual verification of technical claims and system behavior
5 GitHub stars
Link integrity checking for internal and external references
Code example validation for formatting and accuracy
Comprehensive typo and grammatical error detection
Structured reporting via actionable todo lists

Use Cases

Verifying that tutorial code snippets remain functional after updates
Auditing technical manuals before a major software release
Standardizing link references and formatting across large docsets