Documentation managers don't write books. Job Description. You need a Technical Writer.
There is a difference between a documentation manager and a technical writer.
Technical writers ensure that your users understand how your program is to function. I know you think you can write it yourself, but trust me on two things: 1. Every moment you spend writing docs for your users is time you aren't coding. Write a spec on what the system does and give it to QA and a tech writer. The Tech Writer will verify what you wrote against the reality of the system as they write the user docs and QA verifies both the docs and the program. 2. You can neither write as well as you think you can, nor write without ambiguities.
0
07 Oct 2015 12:54
u/Longbow
in v/programming
Documentation managers don't write books. Job Description. You need a Technical Writer.
There is a difference between a documentation manager and a technical writer.
Technical writers ensure that your users understand how your program is to function. I know you think you can write it yourself, but trust me on two things: 1. Every moment you spend writing docs for your users is time you aren't coding. Write a spec on what the system does and give it to QA and a tech writer. The Tech Writer will verify what you wrote against the reality of the system as they write the user docs and QA verifies both the docs and the program. 2. You can neither write as well as you think you can, nor write without ambiguities.