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.
I have made it a HABIT/REQUIREMENT for my documents to have ALL 'buttons,
keys, etc.' to be "ALL CAPS, BOLD" without quotation marks. That way there
is no misinterpretation, and they STAND OUT in the document.
this was specified.In a document style guide that I helped develop for a US
Government agency.
Having been involved with various industry styles (i.e., IBM, NCR) since the
early 1980's the styles that I have encountered. reinforce this approach.
Consistency works, regardless of the way keyboard key caps are made, or how
the displays on the screen appear,
I welcome comments on this approach.
HTH,
Harry Bacheler
hbacheler -at- aol -dot- com
----- Original Message -----
From: "Brasel, Russell" <russell -dot- brasel -at- hccredit -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Sent: Monday, November 27, 2006 12:29 PM
Subject: Style question about quotes
I'm revising a document that predates my employment. It's only a
procedure manual, and a small one at that, but when referring to a field
that appears in the program (and the accompanying screenshot), the text
is:
Clicking the 'New App' button creates a new UAI record.
Don't worry about UAI-that's our internal acronym-but we have a New App
button. How do the rest of you include field labels and button names in
your documents? I've looked at MS Manual of Style, and don't consider
it gospel.
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
Easily create HTML or Microsoft Word content and convert to any popular Help
file format or printed documentation. Learn more 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
Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList