What is best way to show submenus in a document?

Subject: What is best way to show submenus in a document?
From: "Hart, Geoff" <Geoff-H -at- MTL -dot- FERIC -dot- CA>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 1 Jun 2001 13:08:54 -0400

Jim Schoen wonders: <<We have a disagreement in our company about how to
show submenus. Is there a standard that applies. For example, if I were
writing a document for Microsoft word and wanted to demonstrate how to
insert a picture.
Insert>Picture>Clip Art
Is the ">" a standard way to separate these menu options?>>

There are darn few standards in techwhirling, and showing submenus isn't
among them. What we do have is a variety of _preferences_ espoused by
various style guides, with no research available that I'm aware of to
suggest any one approach is best. The problem with using the > symbol is
that it's not intuitive to everyone; I've met enough people who didn't
understand it (e.g., in some of my posts to techwr-l or copyediting-l many
years back) that I'm convinced this approach needs to be defined if you're
going to use it. As a simple visual shorthand, it works perfectly well for
me and probably for most techwhirlers; the question is whether your audience
would recognize it without coaching. The safer (more conservative) approach
is generally some variant of "Open the X menu, select Y, then select Z".

<<If the menu options have a hard key (an underlined option), should the
documentation display the character as underlined. (In this case, should the
"I" in insert, the "P" in Picture, and the "C" in Clip Art be underlined in
a hard copy documentation.>>

I'm an advocate of making the textual representation match the screen
representation as closely as possible, but only when I can convince myself
that doing so provides important information. Thus, underlining the
characters in a screenshot is important because it represents what the users
actually see on the screen, but in running text, the underline probably adds
little or no useful information and only makes the text harder to read. (And
to write, which is an important consideration if you've got to write a lot
of these lines and the developers might be changing the menu shortcuts.)

--Geoff Hart, FERIC, Pointe-Claire, Quebec
geoff-h -at- mtl -dot- feric -dot- ca
"User's advocate" online monthly at
www.raycomm.com/techwhirl/usersadvocate.html

"The most likely way for the world to be destroyed, most experts agree, is
by accident. That's where we come in; we're computer professionals. We cause
accidents."-- Nathaniel Borenstein

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com

Sponsored by Cub Lea, specialist in low-cost outsourced development
and documentation. Overload and time-sensitive jobs at exceptional
rates. Unique free gifts for all visitors to http://www.cublea.com

---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.


Follow-Ups:

Previous by Author: Questions about marketing copy?
Next by Author: Checking assumptions at the door?
Previous by Thread: What is best way to show submenus in a document?
Next by Thread: Re: What is best way to show submenus in a document?


What this post helpful? Share it with friends and colleagues:


Sponsored Ads