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: How many options to give to readers? From:Jo Baer <jbaer -at- mailbox1 -dot- tcfbank -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 23 Mar 2001 10:41:58 -0600
In my opinion, giving too many options in the narrative of a procedure is
distracting and may actually cause the reader to lose the thread. (That opinion
may be influencec by the increasing number of "brain farts" I experience as I
age.) I like the idea of a separate chapter listing all the possibilities; we
have used this method in some of our manuals. I also like the idea of a chapter
on conventions that explains the different methods of accomplishing the same
task.
Since the world always seems to be divided into two kinds of people, I think
that in this instance the world can be divided into keyers and mousers. Most
people do more of one than the other. Because of this, I think it's a good idea
to give people one keying method and one mousing method in the narrative.
If there are unusual options, or you don't want to send your reader to the
appendix all the time, you might consider using side heads to list options not
covered in the narrative. Enclose the options in a box, shaded or not, and place
the box next to the pertinent step or paragraph. Of course this is only
effective if you don't have lots of other things pulled out in side heads. Too
many will clutter the page and readers will tend to ignore them all.
These suggestions are based on my experience and preferences, and may not be
those of the typical consumer.
Jo
--
Jo Baer
Senior Technical Writer
TCF National Bank
Minneapolis, Minnesota
jbaer -at- mailbox1 -dot- tcfbank -dot- com
If you can remain calm, you
just don't have all the facts.
"Walters, Christian (CCI-Atlanta)" wrote:
> Hi all,
>
> Marie mentioned this earlier. It's interesting, because my doc group here
> had a big argument about it just the other day.
>
> How many options for completing the same action do you give to readers?
> There are often several. The same thing can be done by clicking and
> selecting a button, or double clicking, or right-clicking and picking from a
> menu, or from a regular menu, or from a toolbar button, or a shortcut key,
> and so on. Do you guys have any rules o' thumb for that kind of thing?
>
> My gut feeling is to pick which one is the easiest and only tell them that
> one. If they are inexperienced users, too many options may confuse them.
> If they are experienced, too many may annoy them. As they gain experience,
> they will figure out other options anyway. I say dump the toolbar
> descriptions and lists of shortcut keys in a conventions section or an
> appendix and get on with it.
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available 4/30/01 at http://www.devahelp.com or info -at- devahelp -dot- com
A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe. http://ieeepcs.org/2001/
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
