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: Click X, or click the X button? From:"Combs, Richard" <richard -dot- combs -at- Polycom -dot- com> To:"Robert Lauriston" <robert -at- lauriston -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Fri, 23 Oct 2009 14:53:54 -0600
Robert Lauriston wrote:
> I use bold for anything the user has to click or select. I find help
> formatted that way easier to skim.
Likewise. Well, actually, I apply a character format (I'm using
FrameMaker) named GUILabel. It's currently defined to make the font
weight bold and leave everything else as is. But if, in the future, we
decide to make interface elements italic or use a different font, all
I'll have to do is change the definition of GUILabel. There's a lot to
be said for consistently using formats/styles instead of ad hoc
formatting. :-)
> When a menu choice or button label is not in intitial caps, I put
> double quotes around it to distinguish it from running text.
Do you do that _in addition_ to making them bold (or am I
misunderstanding what's bold)?
I seem to recall a study (one of those that I was skeptical of earlier
<g>) that suggested you should only make one change in appearance, not
multiple changes like bold + quotes, or small caps + italic, or blue +
underline (even though that last one seems pretty popular on the
interwebs).
Richard G. Combs
Senior Technical Writer
Polycom, Inc.
richardDOTcombs AT polycomDOTcom
303-223-5111
------
rgcombs AT gmailDOTcom
303-777-0436
------
Free Software Documentation Project Web Cast: Covers developing Table of
Contents, Context IDs, and Index, as well as Doc-To-Help
2009 tips, tricks, and best practices. http://www.doctohelp.com/SuperPages/Webcasts/
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-