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.
Jessica Nealon, wondering about how to format information for various
purposes, wonders: <<Is there some industrious writer with ties to layout
design that are working on something other that bold, italics, underline,
and the courier font?... I need to emphasize one word to convey conceptual
understanding. Bold? That's for anything the user clicks. Italics? That's
for anything in a drop-down list or to describe the result of an action.
Some writers here still use it for emphasis too, but I think it's confusing
to use one highlighting device to both represent and explain the
I think the source of your problem lies in using different formatting for
buttons and choices from lists or results. If you're using boldface to
represent something selected or clicked in an interface, you should probably
use it consistently for both the functions you mentioned. The goal of
formatting is to distinguish certain words from the surrounding text, not to
create a formatting scheme for its own sake. Italics is used (by convention)
to emphasize a word, including foreign words or phrases in running text, so
I'd probably restrict it to this familiar use. My problem with using bold is
that it stands out and makes the page look ink-spattered, particularly in a
button- or menu-heavy interface.
You wondered about alternative conventions, so here's mine:
- menus: Open the File menu. [no emphasis other than to parallel the
standard practice in English of capping a proper noun--the name of the menu;
where the menu name has multiple words, which is rare, cap both words: Open
the File Destruction menu.]
- menu options: Select "What a peculiar menu choice". [quotes used in the
traditional sense to indicate that the phrase is being used as a single
- buttons: Click the "Right" button. [quotes used to indicate that a word
isn't being used in its traditional sense; in this case, I mean that the
button's label is "Right", not that the user should click the righthand
- emphasis: Do this _now_ or kiss your data goodbye. [italics for emphasis]
I'm not suggesting that this is the most elegant way to format things, but
it's both self-consistent and consistent with standard English usage for
quotes, italics, and suchlike. Moreover, it seems to have met with broad
acceptance from my readers thus far.
--Geoff Hart, FERIC, Pointe-Claire, Quebec
geoff-h -at- mtl -dot- feric -dot- ca
"User's advocate" online monthly at
"Some painters transform the sun into a yellow spot; others transform a
yellow spot into the sun."- -Pablo Picasso (1881-1973)
Announcing new options for IPCC 01, October 24-27 in Santa Fe,
New Mexico: attend the entire event or select a single day.
For details and online registration, visit http://ieeepcs.org/2001
Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.
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.