Variations on a task
The Help does contain one of my pet peeves -- the phrase "do one of the
following:" Yuck.
So, how do y'all deal with documenting several different ways of accomplishing the same task?
This simple example shows what I've been doing so far:
1. Open a file using one of these methods:
o From the File menu, select Open.
o On the toolbar, click the Open button (pic of button).
2-n. Next step(s) follow.
I'm not really pleased with this construction, but it's all I've thought of so far. More importantly, my cutomers haven't complained -- they're happy that I document all possible ways of doing something. (This being the reason I haven't spent a lot of time trying to fix it!)
Any other "methods" out there?
-- Melanie
Melanie Fielek, Technical Writer/Editor, mfielek -at- inri -dot- com
Support Coast Guard Search and Rescue -- Get Lost!
All opinions are mine, _mine, MINE!
Previous by Author:
ftp software
Next by Author:
RE: Advice for Job Seekers
Previous by Thread:
Re: Interleaf Dilemma
Next by Thread:
RE: Variations on a task
Search our Technical Writing Archives & Magazine
Visit TechWhirl's Other Sites
Sponsored Ads