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

Try the best git GUI for macOS and Windows
Try the best git GUI for macOS and Windows

Grapple git without the grief and try Tower, the best graphical interface for git on macOS and Windows.

Try Tower for free
Your journey to stunning videos starts here
Your journey to stunning videos starts here

FlexClip is a simple yet powerful video maker and editor for everyone that helps users easily create compelling video content for personal or business purposes without any learning curve.

Try FlexClip

Join my mailing list

My roughly fortnightly newsletter, sent via Substack.

Latest issue: Close the lid on the source (12/11/2026)

View archive