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.
The only place I might ever write the instructions for SW this way is in
individual command displays in context-sensitive help. In a printed manual, I
would say "To set options, select Tools -> Options. The Options dialog is
displayed." Then a brief rundown of each option ("Always Create Backup
Copy checkbox: Creates backup copies yadda yadda,") for each option,
with "Click OK to save options" at the end of the list. There would only be
one instruction to tell the user how to access Options, and one instruction to
say how to conclude. The index entries for each individual option would say,
"See Options," and send the reader to the Options section.
"Isaac Rabinovitch" <isaacr -at- mailsnare -dot- net> wrote in message news:...
> Reasonable question. OK, suppose you're writing about Microsoft Word options.
So you write
> about creating a backup copy. You write "From the 'Tools' menu, choose
> brings up the options dialog box. Click on the 'Save' tab, and make sure that
> Create Backup Copy' is selected."
> Then you have to write about embedding fonts. You write ""From the 'Tools'
> "Options". This brings up the options dialog box. Click on the 'Save' tab, and
> that ..."
> After you've done this 3 or 4 times, your reader is screaming, "I get it, I
GET IT. You
> want me to bring up the options dialog and click on the 'Save' tab!"
Outgoing mail is certified Virus Free.
Checked by AVG anti-virus system (http://www.grisoft.com).
Version: 6.0.588 / Virus Database: 372 - Release Date: 2/13/2004