TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
I wasn't clear about the question on troubleshooting and online
documentation. Were you referring to troubleshooting procedures
for the documentation itself or the product it describes?
If it's for the product, one of the reasons it's not included online
is because many of the problems occur when the software is not accessible
online. When people can't get into the application, they can't get into
its online documentation.
And while marketing groups don't want to promote the problems people have
with their products, they are more than happy to mention their technical
support organizations (some even give tours of the group). So, no, they
ultimately wouldn't squelch troubleshooting info in the documentation.
If it's for the documentation, remember--it's supposed to be easy to use.
Seriously, most organizations hide this information as "help on help'"
and usually, it doesn't.
"
Saul Carliner, Ph.D Student CUISACX -at- GSUVM1 -dot- GSU -dot- EDU
Instructional Technology 404/892-3945 (w&h)
Georgia State University
