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:"Boudreaux, Madelyn (GE Healthcare, consultant)" <Madelyn -dot- Boudreaux -at- ge -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 23 Sep 2008 16:54:49 -0400
Rob Hudson wrote:
>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?
The first is way too hard to follow, and has to be read backwards to be
followed, which is a bad idea. The 2nd is okay embedded in a reference,
but if you're actually describing the steps, break them down.
1. Click the Home menu.
2. Click the Administrator menu.
3. Click the Contacts menu.
4. Click Reports.
Anything more than 2 steps should probably be broken down. If you must
save space, you could write them in line:
Click the Home menu. Next, click the Administrator menu. Next, click the
Contacts menu. Finally, click Reports.
You could use click, select, choose, or something else as per your
preference and selected style guide, but be consistent. (I always want
to mix it up, but creativity just ends up confusing some people.)
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-