Post History
The key question to ask in deciding if something is in or out in technical communication is this: What would the user do differently if they knew this? If the answer it that they would not do any...
Answer
#4: Attribution notice removed
by
System
·
2020-01-03T20:41:49Z (almost 5 years ago)
Source: https://writers.stackexchange.com/a/21102 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:22:09Z (about 5 years ago)
Source: https://writers.stackexchange.com/a/21102 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:22:09Z (about 5 years ago)
The key question to ask in deciding if something is in or out in technical communication is this: What would the user do differently if they knew this? If the answer it that they would not do anything different, then leave it out. Once you have determined if the user would do something different if they knew this, ask, what would they need to know to do this with confidence? Focus on the completion of the action. That which supports the completion of the action is in; that which does not is out. But remember that confidence is key to action. The reader needs to feel that they understand the consequences of an action before they perform it. They need to know what good it will do, and they need to know it will not cause harm. If it helps the user understand the consequences of the action, it's in. Otherwise it's out.
#1: Imported from external source
by
System
·
2016-02-24T16:36:08Z (almost 9 years ago)
Original score: 0