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: How to explain clicking on a submenu From:"Pro TechWriter" <pro -dot- techwriter -at- gmail -dot- com> To:"Rob Hudson" <caveatrob -at- gmail -dot- com> Date:Tue, 23 Sep 2008 16:16:13 -0500
In our documentation (based on DITA), we do something like this:
>From the *Home* menu, select *Administrator > Contacts > Reports.*
-or-
Select *Home > Administrator > Contacts > Reports* from the menu bar to
access the Reports page.
Note that the menu cascade displays in a different font (color and bold)
from the surrounding text in the final docs and the bracket is surrounded by
spaces.
I used to be somewhat opposed to this method, but now I like it. It's short,
clear (when you get used to it), and fast to write. Plus, the menu selection
is usually all on one line, which helps users who scan for an answer to a
question (where is...??).
On Tue, Sep 23, 2008 at 3:03 PM, Rob Hudson <caveatrob -at- gmail -dot- com> wrote:
> Hello Everyone,
>
> If you are clicking the Reports menu of the Contacts menu of the
> Administrator menu of the Home menu, do you say:
>
> 1) Choose Reports from the Contacts Menu of the Administrator menu of
> the Home menu, or
> 2) Choose Home>Administrator>Contacts>Reports?
>
> Or is there a better alternative?
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> ComponentOne Doc-To-Help gives you everything you need to author and
> publish quality Help, Web, and print content. Perfect for technical
> authors, developers, and policy writers. Download a FREE trial.
>http://www.componentone.com/DocToHelp/
>
> 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 pro -dot- techwriter -at- gmail -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit
>http://lists.techwr-l.com/mailman/options/techwr-l/pro.techwriter%40gmail.com
>
>
> To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>http://www.techwr-l.com/ for more resources and info.
>
>
--
"You can only become truly accomplished at something you love....Pursue the
things you love doing, and then do them so well that people can't take their
eyes off you."
- Dr. Maya Angelou
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ComponentOne Doc-To-Help gives you everything you need to author and
publish quality Help, Web, and print content. Perfect for technical
authors, developers, and policy writers. Download a FREE trial. http://www.componentone.com/DocToHelp/
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-