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: Using capital letters From:Peter Brown <pbrown -at- MKS -dot- COM> Date:Fri, 8 Aug 1997 11:26:30 -0400
Jennifer O'Neill wrote:
> A tech writer who recently joined my company uses capital letters in
> a way I can't quite follow and am not very keen about. She just
> handed in a manual with sentences like:
> The Red LED on the Alarm Panel will be lit.
> The Display scrolls through the options.
> When I asked her about it she said that these were key words.
What does "key words" mean?? Only proper nouns should be capitalized in
the middle of a sentence. A regular piece of jargon becomes a proper
noun if the product you're documenting uses it to name a specific object
or concept within that product.
"Press ESC to cancel the operation." Cancel is in lowercase.
"Click Cancel." Cancel is first-caps because it's the NAME of a button.
Now, if the Alarm Panel in your example above is the formal name of a
part of the product (evidenced by its first-capped appearance anywhere
on the surface of a physical object or in the user interface of a
software product), then the usage used above is correct. But "Red"? Not
In the case of software, I like to apply the simple rule of ensuring
consistency with the GUI (as long as the GUI is itself internally
consistent). That means, in most cases, that names of menus, commands,
dialog boxes, and buttons, settings, and fields inside of dialog boxes
"Opinions? I've had a few. But then again, too few to mention."
Peter Brown, Technical Writer (pbrown -at- mks -dot- com)
Mortice Kern Systems Inc. (http://www.mks.com)