Post History
As a software developer, I often find myself writing my own technical documentation and user guides. How much detail should be put into this documentation? When is it too much detail? EDIT I'm...
Question
technical-writing
#3: Attribution notice added
by
System
·
2019-12-08T05:58:52Z (over 4 years ago)
Source: https://writers.stackexchange.com/q/26227 License name: CC BY-SA 3.0 License URL: https://creativecommons.org/licenses/by-sa/3.0/
#2: Initial revision
by
Jon Milliken
·
2019-12-08T05:58:52Z (over 4 years ago)
As a software developer, I often find myself writing my own technical documentation and user guides. How much detail should be put into this documentation? When is it too much detail? **EDIT** I'm stuck on a user simply being able to follow a linear A-\>B process, vs. material that will teach the user how to use the software in a manner that will enable them to handle many errors or process deviations on their own.
#1: Imported from external source
by
System
·
2017-01-23T17:15:03Z (over 7 years ago)
Original score: 4