Test your docs

Doc Detective tests your documentation by running the procedures it describes and checking they still work. Whatever interface a procedure drives (a graphical UI, a command line, or an HTTP API), you’re still testing your docs. This track covers all of it, organized by the kind of interface in front of you.

Where your tests live

Write your docs however you like. You can keep tests inline in a source file, let Doc Detective detect them from your prose, or maintain them as standalone spec files. Start with these regardless of which interface your procedures drive.

Test UI procedures

For docs that walk a reader through a graphical interface. Find and click elements, fill fields, capture fresh screenshots, and record video so visual steps never drift from the product.

Test CLI, code & APIs

For docs that show commands, code samples, and API calls. Run shell and code steps, exercise HTTP endpoints, and check links. Generate tests from an OpenAPI spec so a sample that breaks fails the build.

Across formats and surfaces

All of the above works across input formats, including Markdown, DITA, AsciiDoc, HTML, and custom formats. Contexts extend it across platforms and browsers, so the same docs stay correct everywhere they run.