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.
At 11:49 AM 6/22/97 -0700, Sue Ellen Adkins wrote:
>A recent software review in the San Jose Mercury News started with
>complaints about the manual. The name of the product wasn't even mentioned
(snipped)
> their days figuring out how to write manuals that actually make sense and
cover
> every important point."
Or they could do like other *notable* software developers, and ship the
product with no or only minimal documentation, waiting for a publisher to
pick it up in a dummies series!
Seriously, I wish that MORE software (and hardware) reviews would include
reviews of the documentation...for better or worse. At least it would make
it easier, if the review was favorable, to justify our existence. If the
review was unfavorable, we might eliminate the "weeds" that give us all bad
names. If enough companies caught flak over letting the unqualified or
incompetent do the writing, it would make a better case for those of us who
are beating our heads against the wall in a unified cry for professionalism.
What about it, techwr-lers? Do you ever write to reviewers as a follow up
and ask why they failed to mention the documentation? Maybe we should start!
Jane Bergen
janeber -at- cyberramp -dot- net
Jane Bergen
janeber -at- cyberramp -dot- net
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html