1. EachPod
EachPod

The key to writing good documentation: Testing your instructions

Author
Tom Johnson
Published
Tue 07 Jul 2015
Episode Link
https://idratherbewriting.com/2015/07/07/testing-your-instructions/

Writing good documentation requires you to set up a test environment and test all of your instructions -- testing the instructions yourself and against a user. Testing instructions can be time consuming and tricky, especially with developer documentation. It's hard to see past personal blind spots and assumptions. But testing instructions gives you access to insight that makes your documentation much more accurate and useful.

Share to: