Today, we have Manny Silva, Head of Docs at Skyflow, on the show to talk about two open source projects he created, Docs as Tests and Doc Detective. Docs as Tests is a framework to make sure that your docs are in sync with your product. It's essentially a way to test your docs just like engineers test their code, and Doc Detective is Manny's implementation of that framework.
We discuss the history and motivation behind the projects, what they enable, and how people are using it today.
Timestamps
01:57 Intro
06:51 Testing Documentation
09:26 Competing Against
11:26 Docs as Tests & Doc Detective
13:32 How does one apply these ideas?
16:49 How does test writing work?
19:26 Out of the box checks
23:15 Configurations Structure to create tests
24:28 Integration with the normal flow
28:20 Freshness
29:13 Tools used to build it
32:02 Open Source
33:27 Limitations
35:31 MongoDB's version of Docs as tests
36:42 Innovation Engine by Azure
37:27 Teams using Doc Detective
38:12 At Skyflow
40:52 Future
41:41 How to get started
45:18 Rapid Fire
Links
Docs as Tests: https://www.docsastests.com/)
Doc Detective: https://doc-detective.com/)
