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: What to do when there are multiple paths From:"Sharon Burton-Hardin" <sharonburton -at- earthlink -dot- net> To:"Melanie Shook" <mshook -at- com2001 -dot- com>, "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 16 Sep 1999 09:30:36 -0700
When I have worked on applications like this, I pick one mouse way - the
simplest is usually the button or icon - and one keyboard way. Then I say
"Do one of the following:" followed by 2 bullets that explain each. I always
put the mouse way first and the other second. If they click an icon, I show
it in the margin tucked up to the step it applies to. It is important that
once you choose which is first, you always do it that way. Consistent.
I might put a note in the margin next to the step that they can drag and
drop, if there is room and if the audience is appropriate. I would toss it
if it made the page too dense or complicated. My thoughts...
sharon
Sharon Burton-Hardin
President of the Inland Empire chapter of the STC
www.iestc.org
Anthrobytes Consulting
www.anthrobytes.com
Check out www.WinHelp.net!
See www.sharonburton.com!
----- Original Message -----
From: Melanie Shook <mshook -at- com2001 -dot- com>
To: TECHWR-L <techwr-l -at- lists -dot- raycomm -dot- com>
Sent: Wednesday, 15 September, 1999 2:59 PM
Subject: What to do when there are multiple paths
| A twist on Amy's question:
|
| I'm documenting a telecommunications application that has multiple ways to
| perform a task:
|
| Click on the toolbar
| Using telephone keypad
| Using voice commands over the telephone
| Drag and drop from various places
|
| I'm doing a task oriented user guide, and so far have come up with nothing
| better than explaining each option for each task, in sequence, with a
| graphic in the margin to highlight each method (e.g. a phone, a talking
| head, a PC, etc.) I've included an section in the "quick start" chapter
| that explains the various methods.
|
| Any ideas for a "cleaner" way?
|
|
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| Sponsored by Weisner Associates Inc., Online Information Services
| Don't know where to turn for RoboHELP, HTML, or HTML-based Help
| training? Visit us at http://www.weisner.com or mailto:info -at- weisner -dot- com -dot-
|
| Sponsored by Rose Hill, Your Business and Career Coach.
| "Assume Success! Live Your Passion!" Get the gist at
| http://www.coachrose.com/ then call 503.629.4804 for details!
| ---
| You are currently subscribed to techwr-l as: sharonburton -at- earthlink -dot- net
| To unsubscribe send a blank email to
$subst('Email.Unsub')
| Send administrative questions to ejray -at- raycomm -dot- com -dot-
|
|
