Doc Detective
Keep your docs accurate and up-to-date
Doc Detective tests 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 CLI commands, API calls, and UI actions directly from your documentation.
Never take a manual screenshot again.
Run tests automatically in your CI/CD pipeline to prevent regressions.
How it works
- Bring your docs. Whether in Markdown, AsciiDoc, DITA, or other formats, Doc Detective can read them.
- Detect testable content. Doc Detective scans commands, code blocks, and examples users are expected to run.
- Run the tests. Each instruction is executed in a real environment to confirm it works as documented.
- Get actionable reports. See what passed, what failed, and where your docs need updates.
Built for teams that value accuracy
Ship with confidence knowing your docs match your code.
Verify accuracy without running every command manually.
Keep community-contributed docs reliable and up-to-date.
Make sure onboarding docs stay up-to-date and helpful.
Keep your documentation trustworthy
Instead of assuming your docs still work, Doc Detective continuously verifies them by running real checks against real systems, catching issues before your users do.