If you write documentation for a product that is, itself, code - think SDK, API, or CLI - code is an important part of your documentation!
Take a whirlwind tour through:
- Why it’s important to test code examples in docs
- How you might get started
- How you might level up your code example testing
- How my team tests, extracts, and transcludes code examples in our docs
Audience
People who write or consume documentation that includes code examples. Tech writers, developers, or managers who want to improve accuracy and quality of code examples in the docs.
Resources
- Docs code examples in unit test suites in a public GitHub repository: github.com/mongodb/docs-realm/examples
- Bluehawk docs on GitHub: mongodb-university.github.io/Bluehawk/
- The Bluehawk repository on GitHub: github.com/mongodb-university/Bluehawk
- Ben Perlmutter’s “Unit Test the Docs” talk at Write the Docs Portland: ben.perlmutter.io/blog/unit-test-the-docs-write-the-docs-portland-22/
