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.
I've been pleased with the results of combining the two methods. For
instance, creating a convention in which I place graphic representations
on the left (for right-brain accessibility) and verbal instructions
directly to the right. With the graphic representation, you can include
screen captures (e.g., the pointer pointing at the selection) with
arrows pointing from one step to the next. With the verbal instructions
, I'd suggest a numbered list.
Of course, this method requires a very careful explanation, so that your
readers don't think they're seeing two separate procedures.
From: Scott Miller \ Internet: (smiller -at- corp -dot- portal -dot- com)
To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU (Unlisted Name) \ Internet:
(techwr-l -at- listserv -dot- okstate -dot- edu)
Subject: Toolbar vs Menu
When you document a procedure, do you document the toolbar method or the
menu/command method or both, and why?
The toolbar method:
1. Click {picture of toolbar icon}
The menu/command method:
1. Choose File - New.
Both:
1. Choose File - New.
{picture of toolbar icon}
Disclaimers:
- I looked in the archives already.
- This is not a discussion about the wording of "Choose File - New" or
"From the File menu, choose New," or "Click the pointing-device pointer
at the File pull down menu in the menu bar and clickify the New menu
command option thang." That's in the archives.
