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: Inline key symbols in text From:"Butler, Darren J CTR USAF AFMC 584 CBSS/GBHAC" <Darren -dot- Butler -dot- ctr -at- Robins -dot- af -dot- mil> To:"Chinell, David F (GE EntSol, Security)" <David -dot- Chinell -at- GE -dot- com>, "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 18 Mar 2009 14:00:54 -0400
>> What are your thoughts on using keycap symbols (not keyboards, but
operating controls on an electronic device, for example a tape recorder)
inline in body text, rather than using English names of the keys?<<
I really like having keycaps in text as both a writer and a reader. Of
course, anything can be over-done.
I'd insert the keycap only when directing the reader to locate and/or
execute the item. When discussing theory of operation or a basic
description, I'd use the terminology.
e.g.
step 17. Press % to activate the Disgronification Mode.
Paragraph 4.2. The percent button is a momentary switch that activates
the disgronifier, causing yada-yada-yada......
My $0.02
Darren
-----Original Message-----
From:
techwr-l-bounces+darren -dot- butler -dot- ctr=robins -dot- af -dot- mil -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+darren -dot- butler -dot- ctr=robins -dot- af -dot- mil -at- lists -dot- techwr-l -dot-
com] On Behalf Of Chinell, David F (GE EntSol, Security)
Sent: Wednesday, March 18, 2009 1:45 PM
To: TECHWR-L
Subject: Inline key symbols in text
What are your thoughts on using keycap symbols (not keyboards, but
operating controls on an electronic device, for example a tape recorder)
inline in body text, rather than using English names of the keys?
My biggest objection is the possibility of disrupting the leading of
ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals. http://www.doctohelp.com
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-