test-docs

Executes documentation examples, doctests, and link checks to produce QA evidence.

Updated Sep 3, 2026
One-click install
npx skills add https://github.com/JonusNattapong/A2A-MCP --skill test-docs-jonusnattapong
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: test-docs
Source: https://github.com/JonusNattapong/A2A-MCP/tree/main/src/agenttalk/skills/devkit/test-docs
Command: npx skills add https://github.com/JonusNattapong/A2A-MCP --skill test-docs-jonusnattapong

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Documentation often contains commands, code snippets, generated references, and links that silently drift out of sync with the actual product. This Skill produces executable QA evidence by actually running those documented examples instead of trusting them on inspection alone. ## Core Features & Use Cases - Executable Docs Verification: Runs documentation examples, doctests, command snippets, link checks, generated-reference drift checks, and code-vs-doc assertions in isolated temp environments. - Honest Evidence Reporting: Separates tests_referenced (inspected only) from tests_executed (actually run with observed results), reporting exact commands, outputs, skipped checks, and residual risk. - Use Case: After updating a README quick-start section, use this Skill to execute every documented command in a temp directory, confirm outputs match the docs, and emit a qa-result evidence record flagging any stale flags or broken links. ## Quick Start Run the test-docs skill against the changed documentation in this branch and report which documented commands actually pass when executed.

Frequently Asked Questions about test-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I verify that documentation commands actually work?▼

Run each documented command in an isolated temp directory with explicit environment setup, then compare observed output against the documented output. This Skill automates that process and reports exact commands, outputs, and any drift as executable docs failures.

What is the difference between documentation review and documentation testing?▼

Documentation review (review-docs) is an adversarial check of accuracy, audience, prose, and completeness. Documentation testing executes the docs' commands, doctests, and link checks to produce evidence that documented behavior actually works.

Can documentation tests run commands that need credentials or live services?▼

Commands requiring credentials, live services, or operator-approved environments are not executed. The Skill marks them status=needs-info or records the gap in residual risk rather than falsely claiming they were executed.

Why do generated documentation references drift from the code?▼

Generated references drift when code changes (new flags, changed defaults, renamed commands) are not followed by regenerating the docs. Drift checks compare generated references against current code output and flag mismatches as failures.

When should I not use executable documentation testing?▼

Do not use it for writing documentation, prose or audience review, or general code review. It also cannot validate claims that are only inspected, not executed—green claims based solely on reading docs are out of scope.