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.
Kevin has included two versions of/approaches to the same initialization
steps in his manual, and wonders whether to leave them both in or kill one.
My advice -- as a user of products and programs -- would be to supply only
one set of directions. Chances are that I'd be confused when presented with
two approaches to the same material, even if you told me up front what I was
getting. I'd wonder why I was being presented with two paths. I'm sure that
each approach has different strengths but, when I sit down to use a product,
I want to get productive as soon as possible (and I'd emphasize ASAP). I
don't care about the product per se, only about what it can do for me, how
it will save me time/fill a need/amuse me. I think the best rule of thumb
for user manuals is "easy in, easy out," and one set of directions seems to
meet that criterion more efficiently than two, no matter how wonderful they
both are. The other set of instructions might be of use to your trainers ...
?
Catheryn Mason, Technical Writer
Infinitec Communications
cmason -at- infinitec-com -dot- com
Winner, 1999 IABC Bronze Quill Award of Excellence for Technical Writing
