Does it actually execute my code examples?

Yes, the skill is designed to extract code snippets and attempt to execute them to identify and report verbatim errors found in the documentation.

How does docs-check differ from docs-review?

While docs-review focuses on subjective elements like voice, style, and tone, docs-check focuses on objective technical accuracy, such as verifying that code examples actually run and links are valid.

What does the output report include?

The output provides a clear verdict (PASS, NEEDS WORK, or BLOCKED), a count of blocking issues with specific locations and evidence, and a list of suggestions for improvement.

Can I run this on a specific section of my documentation?

Yes, you can narrow the scope using arguments like '/docs-check just the Quick Start' to audit only a specific section or file.

What kind of documentation files can it check?

It is optimized for Markdown-based documentation including README files, API references, and developer guides within your repository.

Documentation Quality Gate

Name: Documentation Quality Gate
Author: outfitter-dev

byoutfitter-dev

0•

Content Management

Verifies the technical accuracy, completeness, and functional integrity of documentation through rigorous automated checks and code verification.

The Documentation Quality Gate (docs-check) acts as an objective verification layer for technical documentation, ensuring that code examples are runnable, links are valid, and API signatures match the actual source implementation. It moves beyond subjective style reviews by cross-referencing documentation against the codebase to prevent 'documentation rot.' This skill is essential for teams maintaining high-quality READMEs, API references, and developer guides, providing a structured report with pass/fail evidence that serves as a final audit before merging pull requests or publishing new releases.

Key Features

01API signature matching against live source code

02Completeness auditing for parameters, error scenarios, and edge cases

03Structured reporting with classified blocking issues and suggestions

04Automated code example extraction and execution verification

05Link and anchor resolution checking for internal and external paths

060 GitHub stars

Use Cases

01Pre-merge quality audits for documentation pull requests

02Periodic documentation maintenance to prevent technical rot after feature changes

03Verifying README and API reference completeness for new package releases

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add outfitter-dev/agents-internal docs-check

For use in Claude.ai and ChatGPT

Key Features

01API signature matching against live source code

02Completeness auditing for parameters, error scenarios, and edge cases

03Structured reporting with classified blocking issues and suggestions

04Automated code example extraction and execution verification

05Link and anchor resolution checking for internal and external paths

060 GitHub stars

Use Cases

01Pre-merge quality audits for documentation pull requests

02Periodic documentation maintenance to prevent technical rot after feature changes

03Verifying README and API reference completeness for new package releases

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add outfitter-dev/agents-internal docs-check

For use in Claude.ai and ChatGPT