Doc Detective
Test your documentation to make sure every command, example, and instruction still works, so your users don't get stuck.
If code is tested, docs should be too
Doc Detective performs your instructions step-by-step, just like your users would, and reports what works and what doesn't.
Taking the guesswork out of docs maintenance
✓
Test everything
Test CLI commands, API calls, and UI actions directly from your documentation.
📷
Automate screenshots
Never take a manual screenshot again.
⚙️
CI/CD ready
Run tests automatically in your CI/CD pipeline to prevent regressions.
How it works
1
Bring your docs
Whether in Markdown, AsciiDoc, DITA, or other formats, Doc Detective can read them.
2
Detect testable content
Doc Detective scans commands, code blocks, and examples users are expected to run.
3
Run the tests
Each instruction is executed in a real environment to confirm it works as documented.
4
Get actionable reports
See what passed, what failed, and where your docs need updates.
Ready to test your docs?
Start testing your documentation today and ensure your users never get stuck.
Documentation