How to Write Technical How-Tos – Rachel Sobel – Medium
In understanding how to write technical instructions, it’s best to understand how people read them. Most readers will want to know: (1) what you’re doing, and whether it’s relevant to what they are trying to do; and (2) how you did it.
This suggests a simple strategy: first, write about what you’re doing and why, and then, explain how to do it. If you leave out the why, or make it hard to find, your reader will have to closely examine your explanation to understand whether your technique is relevant to them at all. If you leave out the how or make it hard to find, your reader will struggle to replicate your efforts.
March 12, 2018 at 9:55:47 AM EDT
*
FILLER