Post History
The key to good tech writing is not style. Style helps with clarity, and that is useful, but it is not enough. They key is to present the right information to enable a particular user, with a parti...
Answer
#4: Attribution notice removed
by
System
·
2020-01-03T20:41:49Z (almost 5 years ago)
Source: https://writers.stackexchange.com/a/20596 License name: CC BY-SA 3.0 License URL: https://creativecommons.org/licenses/by-sa/3.0/
#3: Attribution notice added
by
System
·
2019-12-08T02:16:35Z (about 5 years ago)
Source: https://writers.stackexchange.com/a/20596 License name: CC BY-SA 3.0 License URL: https://creativecommons.org/licenses/by-sa/3.0/
#2: Initial revision
by
System
·
2019-12-08T02:16:35Z (about 5 years ago)
The key to good tech writing is not style. Style helps with clarity, and that is useful, but it is not enough. They key is to present the right information to enable a particular user, with a particular background and set of skills, to complete a task. The goal is correct action, not necessarily understanding. Too much information is almost as bad as not enough. At best it slows the reader down. At worst it saps their confidence. If they can't see the relevance of the information to their task, they begin to worry that they don't understand the task or the information. The best way to learn to be a good tech writer, therefore, is to figure out what information people do and do not need. There are several ways to do this. One it to do the task yourself and carefully note what information is needed -- particularly noting when you already know something that your target audience may not. Another is to observe actual users, but this can be expensive. A third is to study forums that cover products like yours and see what kinds of questions people ask and what kinds information they need before they are able to successfully solve their problem.
#1: Imported from external source
by
System
·
2016-01-23T05:24:57Z (almost 9 years ago)
Original score: 3