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: Order of menu commands. From:"Pro TechWriter" <pro -dot- techwriter -at- gmail -dot- com> To:"Bill Swallow" <techcommdood -at- gmail -dot- com> Date:Fri, 7 Dec 2007 09:57:16 -0500
Umm. this is what I found in the Microsoft Manual of Technical Style
(looked it up this week so I could use it):
On the Admin menu, click Scheduling, then *point to* Room Maintenance.
I like this because it's fairly simple and works well in most documentation.
However, if the documentation was going to be space-challenged (like a
quick reference card or sheet that went into a packaged product like
the door lockset I installed last weekend), I would use the > or a ->
between the menu items, to save space.
Honestly, I think it depends a whole lot on your audience which
convention you would use. The symbols are great for an engineering or
technical audience, and they appreciate brevity ;-) I tend to spell
things out more for "regular" technology-challenged users.
What do ya'll think? Does the audience matter?
On 12/7/07, Bill Swallow <techcommdood -at- gmail -dot- com> wrote:
> And of course to use the Microsoft convention...
> On the Admin menu, click Scheduling, then click Room Maintenance.
> On Dec 7, 2007 8:17 AM, Will Sansbury <wsansbury -at- alpha -dot- ipswitch -dot- com> wrote:
> > 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.
> Bill Swallow
> HATT List Owner
> WWP-Users List Owner
> Senior Member STC, TechValley Chapter
> STC Single-Sourcing SIG Manager
> 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.
> 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.
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-