What happens after the tests are executed?

The skill analyzes the output report, providing a detailed summary of passed and failed tests, along with descriptions of specific step failures to help you debug your documentation.

Can I embed these tests directly into my markdown files?

Yes, the skill includes an inline test injection workflow that offers to add validated test markup directly into your source documentation for easy execution.

What is the core rule for generating Doc Detective JSON with this skill?

The action name (such as 'goTo', 'click', or 'find') must be used as the JSON key itself. You must never use an 'action' property, as Doc Detective will reject that format.

How does the skill ensure generated tests are valid?

The skill follows a mandatory validation gate where it saves the spec to a temporary file and runs a structural validator before any code is returned or executed.

Does this skill prioritize text matching or CSS selectors?

It prefers text-based element location to closely match the natural language found in documentation, using selectors only when text-based matching is ambiguous or impossible.

Doc Detective Testing

Name: Doc Detective Testing
Author: doc-detective

bydoc-detective

セキュリティとテスト

Automates the verification of documentation procedures by converting text-based guides into executable Doc Detective test specifications.

概要

The doc-testing skill bridges the gap between static documentation and functional software by enabling users to verify that their written procedures actually work. It interprets documentation steps into structural JSON test specifications, enforces strict validation rules to ensure compatibility with the Doc Detective framework, and provides a full workflow for executing tests and analyzing results. This skill is essential for technical writers and developers who want to maintain high-quality, bug-free documentation through automated end-to-end testing and seamless inline test injection.

主な機能

Automated execution support via CLI, Docker, or NPX
Comprehensive results analysis and failure reporting
Mandatory structural JSON validation for Doc Detective compatibility
Text-to-test interpretation for human-readable documentation procedures
0 GitHub stars
Inline test injection to embed executable specs directly into source files

ユースケース

Automating the validation of API procedures and shell command sequences
Regression testing web application UI flows described in technical docs
Verifying tutorial steps and user guides in markdown documentation

概要

主な機能

Automated execution support via CLI, Docker, or NPX
Comprehensive results analysis and failure reporting
Mandatory structural JSON validation for Doc Detective compatibility
Text-to-test interpretation for human-readable documentation procedures
0 GitHub stars
Inline test injection to embed executable specs directly into source files

ユースケース

Automating the validation of API procedures and shell command sequences
Regression testing web application UI flows described in technical docs
Verifying tutorial steps and user guides in markdown documentation