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.
Our team is having a major disagreement that I hope you can help with. Our
department style guide states the following:
When instructing the user to perform some action on the user interface, use the
term "Select" rather than "Click," "Choose," or "Press."
Use "Click" only when the user must Right-click, to specify such.
The only time Press is used is when the user must interact with the keyboard, as
in "Press Enter."
Recently, our development team created a lexicon of approved terms for the new
user interfaces. According to their lexicon, when instructing a user to take
action on a button (Ok, Cancel, Save, etc) on the user interface, we should use
"Press" rather than "Select" since the button does not have a deselect state.
We feel this is inaccurate because Press indicates a physical action when the
only physical action the user is taking is clicking a mouse button on a
graphical representation of a button on the user interface. We think that
Select works fine for buttons, menu items, etc. It's clear that there is a
choice and the user should select the indicated item. We feel that using Select
in some instances and Press in others would just muddy the waters and make our
documentation look inconsistent (all of our legacy documentation uses Select).
So...I appeal to TECHWR-L for answers/opinions. Do you know of any
authoritative source that dictates user actions according to GUI components? Is
this merely a matter of opinion? Would we be wrong to stick with "Select" and
keep our documentation consistent or are we doing the user a disservice and
using terminology incorrectly (the Microsoft Computer Dictionary lists Select
but not Press).
All input is greatly appreciated. Thanks in advance for your help!
Kim
_________________________________
Kim McCarter
Information Design & Development
Harris Corporation, Network Support Division
(321) 724-3497
kmccarte -at- harris -dot- com
*****Confidentiality Notice*****
This message is confidential . If you are not the intended recipient, you may
not copy or otherwise disclose the contents of this message to any other person.
If you have received this message in error, please contact the sender
immediately by return e-mail. Thank you.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Are you using Doc-to-Help or ForeHelp? Switch to RoboHelp for Word for $249
or to RoboHelp Office for only $499. Get the PC Magazine five-star rated
Help authoring tool for less! Go to http://www.ehelp.com/techwr
Free copy of ARTS PDF Tools when you register for the PDF
Conference by April 30. Leading-Edge Practices for Enterprise
& Government, June 3-5, Bethesda,MD. www.PDFConference.com
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.