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.
> My opinion is that you should never present more than one equivalent
> method
> of accomplishing something in a procedure. If someone is reading a
> step-by-step procedure it is because they want to get a specific task
> done.
> One method will suffice for this purpose; offering an alternative is
> just a
> distraction.
>
> A person who is sufficiently unfamiliar with the product to require
> instruction of this kind does not need the extra chore of choosing
> between
> two alternative, especially when there is no guidance provided on why
> to
> choose one option over the other. Make their life simpler: choose for
> them.
> If a person uses the application often, they will learn that there are
> alternate ways of doing things. If they don't use it often, they don't
> care
> that there are alternate ways of doing things.
>
> A good topic should do one thing. Putting alternative methods into a
> procedure is an attempt to teach the interface to a user who is just
> trying
> to get a job done. For users who want to learn the interface, write a
> topic
> on how the interface works.
>
> But if you absolutely must state the alternatives, the first form is
> both
> clearer and more conventional.
What he said. In large neon letters. With full orchestral accompaniment.
Richard G. Combs
Senior Technical Writer
Polycom, Inc.
richardDOTcombs AT polycomDOTcom
303-223-5111
------
rgcombs AT gmailDOTcom
303-903-6372
------
Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days. http://www.doctohelp.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-