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: Display, Displays, or Appears From:"McLauchlan, Kevin" <Kevin -dot- McLauchlan -at- safenet-inc -dot- com> To:"Chinell, David F (GE EntSol, Security)" <David -dot- Chinell -at- GE -dot- com>, "Downing, David" <DavidDowning -at- Users -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 10 Jun 2008 09:59:23 -0400
Chinell, David F said:
> Not in my shop. We only tell the reader where he or she is if there's
a
> high possibility of them being somewhere else instead.
>
> In short, we follow the MS MoS as best we are able. Here's what they
> say.
>
> "As a general rule, tell the user where the action should take place
> before describing the
> action to take. This prevents users from doing the right thing in the
> wrong place. However,
> avoid overloading procedures with locators. Assume that the user is
> looking at the screen
> and is starting from the position where the procedure begins. For
> example, the following
> phrasing is typical: "On the View menu, click Zoom."
I think it's possible that the writers of Help (and such) for The GIMP,
OpenOffice, and several other programs might not have embraced the MMoS.
I often find that instructions for performing a task start with a menu
or option but don't tell me how I got to that menu. I then start looking
through all the menu-bar items, then right-clicking everything in sight,
then trying other measures to invoke this-or-that tool-bar that (I might
not know until I open it) is the place to find the menu I needed.
Of course, since Microsoft began having most of their MS Office Help on
their servers, instead of on my computer, I also find that I encounter
"chunk" task instructions that don't identify how one gets to the
chunk's starting point.
Kevin
The information contained in this electronic mail transmission
may be privileged and confidential, and therefore, protected
from disclosure. If you have received this communication in
error, please notify us immediately by replying to this
message and deleting it from your computer without copying
or disclosing it.
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-