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: Industry Standard for Shift 'n Click? From:Frank <frank -at- research -dot- canon -dot- com -dot- au> To:Kurt Kramer <kurtmkramer -at- gmail -dot- com> Date:Fri, 05 May 2006 08:49:18 +1000
Hi Kurt,
The /Microsoft Manual of Style/ (version 3) has an entry for referring
to key names:
In general, spell key names as they appear in the following list,
whether the name appears in text or in a procedure. Use all caps
unless otherwise noted.
*Note* This list applies to Microsoft and IBM-type keyboards unless
otherwise noted. For more information about keys on the Microsoft
Natural Keyboard, see Microsoft Natural Keyboard Key Names
<#idh_microsoft_natural_keyboard_key_names>. Differences with the
Macintosh keyboard are noted.
*Correct
*ALT
ALT GR
Application key [Microsoft Natural Keyboard only]
arrow keys [not /direction keys, directional keys, /or /movement keys/]
BACKSPACE
BREAK
CAPS LOCK
CLEAR
COMMAND [Macintosh keyboard only. Use the bitmap to show this key
whenever possible, because the key is not named on the keyboard.]
CONTROL [Macintosh keyboard only. Does not always map to the CTRL
key on the PC keyboard. Use correctly.]
CTRL
DEL [Macintosh keyboard only. Use to refer to the forward delete key.]
DELETE [Use to refer to the back delete key on the Macintosh keyboard.]
DOWN ARROW [use "the" and "key" with the arrow keys except in key
combinations or key sequences. Always spell out. Do not use
graphical arrows.]
END
ENTER [On the Macintosh, use only when functionality requires it.]
ESC [Always use ESC, not ESCAPE or Escape, especially on the Macintosh]
F1--F12
HELP [Macintosh keyboard only. Always use "the HELP key" to avoid
confusion with the *Help *button.]
HOME
INSERT
LEFT ARROW [use /the/ and /key/ with the arrow keys except in key
combinations or key sequences]
NUM LOCK
OPTION [Macintosh keyboard only]
PAGE DOWN
PAGE UP
PAUSE
PRINT SCREEN
RESET
RETURN [Macintosh keyboard only]
RIGHT ARROW [use /the/ and /key/ with the arrow keys except in key
combinations or key sequences]
SCROLL LOCK
SELECT
SHIFT
SPACEBAR [precede with /the/ except in procedures, key combinations,
or key sequences]
SYS RQ
TAB [use /the/ and /key/ except in key combinations or key sequences]
UP ARROW [use /the /and /key /with the arrow keys except in key
combinations or key sequences]
Windows logo key [Microsoft Natural Keyboard only]
Spell key names that do not appear in this list as they appear on
the keyboard.
When telling a user to "press" a key, format the key name in all
caps. When telling a user to "type" a key, use lowercase bold,
unless an uppercase letter is required.
*Correct
*Press Y.
Type *y*.
*Note* Format punctuation according to intended use. If the user
must type the punctuation, use bold. If not, use roman.
At first mention, you can use /the /and /key /with the key name if
necessary for clarity --- for example, "the F1 key." At all
subsequent references, refer to the key only by its name --- for
example, "press F1."
For the arrow keys and the TAB key, list only the key name in key
combinations without /the /and /key./
*Correct
*To move the insertion point, use the LEFT ARROW key.
To extend the selection, press SHIFT+LEFT ARROW.
*Special character names
*Because these keys could be confused with an action (such as +) or
be difficult to see, always spell out the following special
character names: PLUS SIGN, MINUS SIGN, HYPHEN, PERIOD, and COMMA.
*Correct
*SHIFT+PLUS SIGN
Press ALT, HYPHEN, C
Press COMMA
Press COMMAND+PERIOD
Type an em dash
Press the PLUS SIGN (+)
*Incorrect
*SHIFT+ +
SHIFT+ -
Press +.
You can add the symbol in parentheses after the special character
name --- for example, PLUS SIGN (+). Use discretion in adding
symbols, however; it may not be necessary for commonly used symbols
such as PERIOD (.).
Hope this helps.
Regards,
Frank.
Kurt Kramer wrote:
Has anyone come across an industry standard for documenting usage of both
the Shift key and a mouse click? Or, similarly, the Ctrl key and a mouse
click? Would this be documented as Shift+Click or Shift-Click? (For
that
matter, would Click be capitalized or not?)
Thanks!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient
content delivery. Try it today!. http://www.webworks.com/techwr-l Doc-To-Help includes a one-click RoboHelp project converter. It's that
easy. Watch the demo at http://www.DocToHelp.com/TechwrlList
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!. http://www.webworks.com/techwr-l
Doc-To-Help includes a one-click RoboHelp project converter. It's that easy. Watch the demo at http://www.DocToHelp.com/TechwrlList