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:How many options to give to readers? From:"Walters, Christian (CCI-Atlanta)" <Christian -dot- Walters -at- cox -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 23 Mar 2001 11:19:49 -0500
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.
But I can see there are other POVs on this. And it can be moot anyway if
you have a project manager who views a manual as a repository of every scrap
of information regarding the program.
As for the discussion yesterday, I'm beginning to come around on the menu
thing :)
C
-----Original Message-----
From: Marie C. Paretti [mailto:mparetti -at- naxs -dot- net]
<peeve> "Click" is actually one of my pet peeves, since for
most commands on most programs, you don't need the mouse
; there are often a variety of keyboard methods for executing
commands. So I almost never write "Click this"; I tell them
what to select, and let them choose their method. </peeve>
*** 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.