Technical Documentation Validator

•
33
•

Validates AsciiDoc documentation for technical accuracy, style compliance, and structural integrity using automated tools and AI cross-referencing.

This skill provides a comprehensive validation pipeline for technical documentation, combining deterministic linting with advanced AI analysis. It executes industry-standard tools like Vale for style, Asciidoctor for syntax, and Lychee for link checking, while uniquely leveraging Claude to cross-reference embedded CLI commands, API paths, and YAML snippets against actual source code or context files. It is an essential tool for developers and technical writers who need to ensure their documentation remains technically accurate, structurally sound, and perfectly synchronized with their software's current state.

主要功能

0133 GitHub stars
02Multi-tool integration with Vale, Asciidoctor, and Lychee for automated linting
03LLM-powered cross-referencing of CLI flags and API paths against project context
04Structural compliance checks for standardized AsciiDoc module requirements
05Comprehensive JSON reporting of all findings categorized by severity and tool
06Automated YAML syntax verification for embedded documentation code blocks

使用场景

01Ensuring style guide consistency and link health before merging documentation PRs
02Verifying that documentation examples match the actual CLI help output or API specs
03Automating quality assurance for large-scale technical documentation repositories