Text-based menus?

Subject: Text-based menus?
From: "Hart, Geoff" <Geoff-H -at- MTL -dot- FERIC -dot- CA>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 7 Jan 2002 09:37:50 -0500

Wade Courtney needs to document <<... a text based menu. What is best way
to do this. Menu selections are in a numerical list - for example 1
configuration 2 tools 3 logout>>

There's rarely any one "best" way to do such things. Here, you can pretty
much use any of the standard approaches for documenting a GUI menu:
- put the choices in a table, with the choice on the left and the
explanation on the right
- use each menu choice as a heading or subheading for its own section
- use a screenshot with callouts pointing at each choice and providing an
explanation
- define a series of tasks required to reach some endpoint, in a logical
order, then explain the menu choice that relates to each task

Which one is "best" depends on the approach your audience will take to using
the menu, and the kinds of problems you might encounter applying each
approach to your specific situation; for example, a table approach won't
work well if the descriptions for each menu command extend beyond a
paragraph or two, and the task-based approach requires some arbitrary
decisions if there's no logical sequence, as in the example you provided.
Try out each approach to see which one works best!

--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

"Any sufficiently advanced technology is indistinguishable from a
personality, and an obnoxious one at that."-Kim Roper

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Collect Royalties, Not Rejection Letters! Tell us your rejection story when you
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of
your book. What are you waiting for? http://www.iuniverse.com/media/techwr

Have you looked at the new content on TECHWR-L lately?
See http://www.raycomm.com/techwhirl/ and check it out.

---
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.


Previous by Author: Science writing: 2 conferences (plus STC value)
Next by Author: What about the client's needs? (was: What would Andrew do)
Previous by Thread: FW: RE: PDF Conversion Problem, using Word
Next by Thread: eforms and Acrobat


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


Sponsored Ads