RE: Order of menu commands.

["Will Sansbury" <wsansbury -at- alpha -dot- ipswitch -dot- com>]

Our approach is to document everything that can be done in one simple path
without interruption in one line.

For example, we would write:
Click Start > Programs > Accessories > Notepad. The Notepad applications
appears.

If the steps have an interruption in them, such as a new window, dialog, or
window appearing, we break them into multiple steps, detailing the result of
each action in between.
1. Click Start > Control Panel. The Control Panel appears.
2. Double-click Administrative Options. The Administrtative Tools folder
opens.
3. Right-click on the Services icon and select Send To > Desktop (create
shortcut). A new shortcut icon to Services is created on your desktop.

So in your example, it kind of depends where the system does things. If you
click Admin and the Admin module loads, then I'd write it like this:
1. Click Admin. The Admin module appears.
2. Select Scheduling > Room Maintenance. The Room Maintenance dialog
appears.

This is, of course, just how we do it. The most important thing is that you
define a standard and adhere to it with near-religious zeal.

Hope that helps...

Will Sansbury

> -----Original Message-----
> From: 
> techwr-l-bounces+wsansbury=alpha -dot- ipswitch -dot- com -at- lists -dot- techwr-l -dot- c
> om 
> [mailto:techwr-l-bounces+wsansbury=alpha -dot- ipswitch -dot- com -at- lists -dot- te
> chwr-l.com] On Behalf Of Zen C
> Sent: Friday, December 07, 2007 7:17 AM
> To: techwr-l -at- lists -dot- techwr-l -dot- com
> Subject: Order of menu commands.
> 
> Hi All,
> 
> 
> 
> What is the best way to write the following step?
> 
> 
> 
> 1.Click *Admin* module |*Scheduling*| *Room Maintenance*.
> 
> 2.Click the *Room Maintenance* link under the *Scheduling* 
> section of the *
> Admin* module.
> 
> 3.Click *Admin *module, *Scheduling*, and then click *Room 
> Maintenance * link.
> 
> 
> Ideas pls?
> 
> Zen
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> 
> 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 
> wsansbury -at- alpha -dot- ipswitch -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/wsansbury%4
0alpha.ipswitch.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.
> 
> 

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

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- 

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/archive%40web.techwr-l.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.