4
4
0
https://opensource.com/business/15/5/write-better-docs?sc_cid= [login to see] 11jJaAAI
What are your tips for writing technical documentation ?
What are your tips for writing technical documentation ?
RTFM? How to write a manual worth reading
Posted from opensource.comPosted in these groups: 
Creative Writing
Writing and Editing
Writing
Open Source
Information Technology
Creative Writing Writing and Editing Writing Open Source Information Technology
Posted >1 y ago
Responses: 7
1
1
0
PO3 Steven Sherrill
SGT (Join to see) I will only use that when I get the same question from the same person on a repeated basis. If the rep doesn't have the time to learn the system, I don't have the time to do it for them. I will make them read the manual.
(1)
(0)
SGT (Join to see)
PO3 Steven Sherrill - That is completely understandable. Actually, if I'm being reflective, my last statement probably shouldn't state "oftentimes" because there are times when, as tech support, people will want to ask the same questions or simply want you to fix it for them.
(1)
(0)
PO3 Steven Sherrill
SGT (Join to see) - "Do it For Me, because I can't be bothered." is the translation of about 60% of the calls I receive.
(1)
(0)
0
0
0
One thing to try is user a technical manual for something you know nothing about, and now what is hard or confusing. Usually you are leaving something out. So develop a sense of what a new user would need filled in.
(0)
(0)
0
0
0
Read This Next
Continue with Facebook 
Continue with Google