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.
Subject:Re: Menus and Toolbars From:Janice Gelb <Janice -dot- Gelb -at- Sun -dot- COM> To:baj357 -at- gmail -dot- com Date:Sun, 13 Jan 2008 09:19:44 +1100
Ben wrote:
>
> In addition to task-oriented info, any opinions or
> insight about documenting reference info about toolbars
> or menus, e.g. listing menu names or buttons followed
> by brief descriptions? Do you think it's useful for
> readers who want quick info about a menu or button on a
> toolbar? IMO, I'd like to avoid the menu and toolbar
> reference info, because it seems unncessary, but I can't
> help to think someone may find it useful, especially if
> the tool tips aren't as informative.
>
I don't believe this is necessary for menus. Readers
really only need to know about menu options and their
location when they're using them to do a task, so
describing them in the context of that task seems
sufficient.
However, regarding a toolbar reference, I think an
illustration can be helpful if your toolbar is extensive.
Icons that seem to be crystal clear to the designer can
often be cryptic to other people.
-- Janice
***********************************************************
Janice Gelb | The only connection Sun has with
janice -dot- gelb -at- sun -dot- com | this message is the return address
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-