• Shaarli
  • Tag cloud
  • Picture wall
  • Daily
  • RSS
  • Login
4253 shaares
Filters

How to Write Technical How-Tos – Rachel Sobel – Medium

QRCode

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.

https://medium.com/@rachel.sobel/how-to-write-technical-how-tos-4279d2534786
March 12, 2018 at 9:55:47 AM EDT *
writing
FILLER
Shaarli · The personal, minimalist, super fast, database-free, bookmarking service by the Shaarli community · Documentation
Fold Fold all Expand Expand all Are you sure you want to delete this link? Are you sure you want to delete this tag? The personal, minimalist, super fast, database-free, bookmarking service by the Shaarli community