What file types does Inline Test Injection support?

The skill supports a wide range of documentation formats including Markdown (.md), MDX (.mdx), HTML, XML/DITA, and AsciiDoc (.adoc).

Does it handle custom markup or configurations?

Yes, if a .doc-detective.json or .doc-detective.yaml file exists in your project, the skill will load and respect your custom markup patterns.

How does it know where to place the test steps in the document?

It uses a semantic matching engine that scores the similarity between test actions (like 'click' or 'type') and document elements (like links or bold text) to place comments exactly where they belong.

What happens if a test step doesn't match any text in my doc?

Steps that cannot be matched semantically are flagged as 'unmatched' in the preview and are typically placed at the end of the document for manual placement.

Can I see the changes before my files are modified?

Yes, the skill includes a preview mode that generates a diff of the planned injections so you can review accuracy before applying the changes.

Inline Test Injection

Name: Inline Test Injection
Author: doc-detective

bydoc-detective

学習とドキュメンテーション

Integrates Doc Detective test specifications directly into documentation source files as semantic inline comments.

概要

The Inline Test Injection skill automates the process of embedding Doc Detective test steps into documentation formats like Markdown, HTML, and AsciiDoc. By utilizing semantic pattern matching, it intelligently aligns test actions—such as clicking buttons or navigating to URLs—with the corresponding text in your guides. This ensures that your documentation and underlying tests remain perfectly synchronized, making it an essential tool for teams practicing documentation-driven testing and DocOps workflows.

主な機能

Preservation of document indentation and structure during injection
0 GitHub stars
Preview mode with diff visualization to review changes before applying
Automatic syntax detection for file-specific comment styles
Support for Markdown, MDX, HTML, AsciiDoc, and XML/DITA formats
Semantic matching of test steps to UI instructions (links, bold text, actions)

ユースケース

Converting standalone test files into inline documentation-based tests
Synchronizing UI verification steps with step-by-step user guides
Automating the maintenance of executable documentation in CI/CD pipelines

概要

主な機能

Preservation of document indentation and structure during injection
0 GitHub stars
Preview mode with diff visualization to review changes before applying
Automatic syntax detection for file-specific comment styles
Support for Markdown, MDX, HTML, AsciiDoc, and XML/DITA formats
Semantic matching of test steps to UI instructions (links, bold text, actions)

ユースケース

Converting standalone test files into inline documentation-based tests
Synchronizing UI verification steps with step-by-step user guides
Automating the maintenance of executable documentation in CI/CD pipelines