Unit Test the Docs - Write the Docs Portland '22

Technical writers face the constant challenge of keeping code examples accurate and up-to-date. Just as software developers write unit tests to validate that their code remains functional, technical writers can create code examples within unit tests to validate that their documentation is correct.

This talk covers:

• Why you should write code examples within unit tests
• What you should test
• How to implement tested code examples using Bluehawk
• How to set up continuous integration tests to make sure that code examples always work

Video

Slides

Sketchnotes

Thanks @nitya!