Can I review changes before they are applied to my files?

Yes, the script runs in a preview mode by default, showing a diff of planned changes so you can verify the placement before using the --apply flag to write to the file.

When should I use this over a general tool like Playwright?

Use this skill specifically for documentation-driven testing where you want to verify that UI instructions in your guides actually work; use Playwright for complex browser automation and custom framework building outside of content files.

How does semantic matching work for test injection?

The skill analyzes test actions (like click or type) and values to find matching patterns in your text, such as bolded words for buttons or hyperlinks for navigation, to place the test step accurately.

Which file formats does this skill support?

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

What is the main benefit of using inline tests in documentation?

Inline tests keep your automated test steps directly next to the documentation they verify, making it easier to maintain and ensuring tests stay synchronized when content is updated.

Inline Test Injector

Name: Inline Test Injector
Author: doc-detective

bydoc-detective

•

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

Injects Doc Detective test specifications into documentation source files as inline comments using semantic pattern matching.

The Inline Test Injection skill streamlines the process of synchronizing documentation with automated tests by embedding Doc Detective specifications directly into source files like Markdown, MDX, and AsciiDoc. By utilizing semantic pattern matching, it identifies relevant content—such as links, UI buttons, or instructions—and places corresponding test steps precisely where they belong. This ensures that your documentation remains verifiable and functionally accurate, making it an essential tool for teams practicing 'documentation as code' who want to automate UI testing within their existing content workflow.

主な機能

01Preservation of document indentation and structure during injection

02Support for Markdown, MDX, HTML, AsciiDoc, and XML/DITA file formats

03Semantic pattern matching to align test steps with relevant documentation text

046 GitHub stars

05Preview mode with diff visualization to review changes before applying

06Automatic comment syntax detection based on file extension

ユースケース

01Converting standalone Doc Detective test files into an integrated inline format

02Maintaining documentation accuracy by keeping test logic close to its associated content

03Automating the verification of UI steps and links within technical user guides

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add doc-detective/agent-tools inline-test-injection

For use in Claude.ai and ChatGPT

Download Skill