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've been asked by my company's marketing department to write a Reviewer's
Guide for one of our software products. I haven't written one before so I'm
looking for some help.
I have searched the techwirler archives for info on this topic, but to no
avail.
By reviewing other reviewer's guides (ha) I've been able to forge a coherent
outline.
However, I would be interested in tech writers' thoughts on the two topics
below. You can respond to me off-list and I'll post a summary of the
responses.
1. purpose - The examples I have reviewed are either glorified marketing
copy or super-boring installation-only guides. If my purpose is not, "here's
how to use my product and what I think you should concentrate on as you
review it", what should it be?
2. audience sophistication level - In the small sampling of documents I
reviewed, I did not find the installation/product navigation instructions to
be very user-friendly, to put it nicely. Is it acceptable/common practice
to forego procedure-type instructions in favor of paragraphs that point out
product features? Can I expect an audience of technology reporters to be
able to find their way around a GUI?
Thanks in advance for your help!
Jennifer L. Collins
Technical Writer
Riverbed Technologies, Inc.
703.847.3303 x121
jcollins -at- riverbedtech -dot- com
