Testing Code Examples in Documentation
Published on December 21, 2016
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
The AI writing tool with unparalleled story smarts
Sudowrite is an AI-powered writing assistant that helps you brainstorm, outline, and write your stories.
Sign up for Sudowrite
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