Post History
The acid test is this: Will the reader behave differently if they know this? If not, leave it out. The aim of user documentation is to enable the user to act correctly. Any detail that does not con...
Answer
#4: Attribution notice removed
by
System
·
2020-01-03T20:41:52Z (almost 5 years ago)
Source: https://writers.stackexchange.com/a/26231 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-08T05:58:54Z (about 5 years ago)
Source: https://writers.stackexchange.com/a/26231 License name: CC BY-SA 3.0 License URL: https://creativecommons.org/licenses/by-sa/3.0/
#2: Initial revision
by
System
·
2019-12-08T05:58:54Z (about 5 years ago)
The acid test is this: Will the reader behave differently if they know this? If not, leave it out. The aim of user documentation is to enable the user to act correctly. Any detail that does not contribute to correct action slows the reader down and may reduce their confidence.
#1: Imported from external source
by
System
·
2017-01-23T17:53:30Z (almost 8 years ago)
Original score: 3