Skip to content

Testing Code Examples in Documentation

Published on December 21, 2016

Testing Code Examples in Documentation

In my last post, I covered how to improve the written component of your documentation with automated spell-checking and suggestions for better writing. In this post, I’ll cover the code component of good documentation; trying an example and finding it doesn’t work is a sure-fire way to annoy a reader.

If you like what you're reading, support my work

Capture your screen effortlessly
Capture your screen effortlessly

Simple and clear, but packed with features, Simple Screenshot is a drop in replacement for macOS.

Get Simple Screenshot

Join my mailing list

My roughly fortnightly newsletter, sent via Substack.

Latest issue: All chAInge (29/10/2026)

View archive