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.
This method seems to work for my engineers & customers:
"Open the Source window Breakpoints menu Set Breakpoint dialog. You
can add, delete, and edit breakpoints as follows ..." (The Set
Breakpoint item opens a whole separate dialog.)
"Enable a signal in the CPU window Options menu Signals item." (The
Signals item has a sub-menu of items that can be enabled with a
click/checkmark.)
"Enable the Source window View menu Source Only item." (The Source
Only item can be enabled with a click/checkmark.)
Luckily, the menus I'm documenting only ever go 3 deep at most. The
above style would get too nested otherwise. I think I'd break it into
two phrases or sentences at that point -- for example, "Choose the
Source window View menu Format item; enable a Color Scheme value."
(Where Color Scheme, an item under Format, itself has a submenu.)
I also use notational conventions (bold, monospace, italics) to
distinguish between menu items, field names, verbatim (or example)
field values/keywords, and placeholders for the field values/keywords.
==
RolyBear, icq-1863181
_________________________________________________________
DO YOU YAHOO!?
Get your free @yahoo.com address at http://mail.yahoo.com
