For AI agents: a documentation index is available at /llms.txt — markdown versions of all pages are available by appending index.md to any URL path.

Microblog

I recently wrote about why you should test the code examples in your documentation

Documentation

I recently wrote about why you should test the code examples in your documentation. That led to some interesting conversations - notably about who should be writing the code examples in your documentation.

After talking with other technical writers and engineers, I jotted down some of the benefits of having the documentation team writing the code examples. I'm sure I've missed some!

Do you have opinions about whether #TechnicalWriters or #Developers should be writing the example code in your docs? Tell me about them - I'd love to hear it!

All microblog posts · RSS