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.
Subject:Re: Prod reviews--why not include doc??? From:John Posada <john -at- TDANDW -dot- COM> Date:Thu, 4 Mar 1999 10:18:16 -0500
In my portfolio, I carry a reprint that I ordered from a magazine called
"Internet Telephony" where they reviewed an API SDK done by my company
and not only do they have a section called DOCUMENTATION, but they place
the review FIRST, right after the list of software features and before
INSTALLATION or OPERATIONAL TESTING. ALSO, on the first page of a four
page review, they have a rating table and list documentation in the
table.
It can happen
>
> (I have a point, and I'm getting to it...) Which brings me to a question:
> why is it, that when I read Product Reviews in various
> technical/computing publications, I can almost *never* find 1 comment on
> the quality of the doc, hard copy or online! The only focus is on the
> product itself!
>
> As a doc manager, I would like to know how a product reviewer rates
> the documentation that comes with the product. It can give my team some
> insight to user's frustrations and delights. And, if it's a viable product or
> maybe even a really crappy one, we may purchase it to grow our
> collection of doc samples.
>
--
John Posada, Technical Writer
Bellcore, where Customer Satisfaction is our number one priority mailto:john -at- tdandw -dot- com mailto:jposada -at- notes -dot- cc -dot- bellcore -dot- com
phone(w) 732-699-3077 phone(h) 732-2910-7811
alpha-pager: 800-864-8444 pin 1857522 http://www.tdandw.com
email pager: mailto:1857522 -at- pagemart -dot- net
My opinions are mine, and neither you nor my company can take credit for
them.
"Give a man a fish and he will eat for a day. Teach him how to fish,
and he will sit in a boat and smoke cigars all day."
"The only perfect document I ever created is still on my hard drive."