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.
Depends on the product you're talking about. When dealing with most online
help, I've found it of little help. So the presence of a complete, hard copy
manual makes a big difference to me.
Now that the software end of TC has been dealt with, let's address the hardware
end. I have encountered hardware that otherwise worked fine, but came with
abysmal documentation. If you have to install or troubleshoot the hardware,
abysmal documentation will have you ready to return the hardware right away!
David Jones, Technical Writer
David_Jones/KSBEISD -dot- KSBEISD -at- Datahub -dot- com
The views described herein are the views of the author, and
do not represent the views or opinions of Kamehameha Schools
Bishop Estate, nor is there any approval or authorization of
this material, express or implied, by the Kamehameha Schools
Bishop Estate. If you suspect that any of the material in
this message or attachments thereto is in violation of a
copyright, please notify the Webmaster immediately by e-mail
at "Webmaster -at- ksbe -dot- edu".
To: TECHWR-L @ LISTSERV.OKSTATE.EDU
From: mjwing @ INGR.COM ("Wing, Michael J")
Date: 08/26/96 05:26:43 PM
Subject: Re: Sanity check
>My feeling about good writing, in help files, and everywhere else in
>product documentation, is that good writing reassures the user that
>product is worthwhile.
I half agree with you. I can see where poor documentation can make a
user think that the product is less worthwhile than it really is, but I
can't completely see it the other way around. IMO, it is the cost,
availability, ease-of-use, compatibility, and functionality that sells
me on the product. If the product does what I want, is available, and
is affordable, then I will suffer with less-than adequate documentation.
However, I may not suffer quietly.
TECHWR-L List Information
To send a message about technical communication to 2500+ list readers,
E-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send administrative commands
ALL other questions or problems concerning the list
should go to the listowner, Eric Ray, at ejray -at- ionet -dot- net -dot-