Re: Quotation marks around user interface labels

Subject: Re: Quotation marks around user interface labels
From: Ruth Sessions <ruthsessions03051 -at- yahoo -dot- com>
To: "Combs, Richard" <richard -dot- combs -at- Polycom -dot- com>, Nancy Allison <maker -at- verizon -dot- net>, "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 19 Jul 2011 11:40:22 -0700 (PDT)

Nancy:
 
Although initial caps might be sufficient to distinguish GUI labels in text, bolding those labels makes it much easier for them to stand out. It's hard to imagine anyone using quotation marks at this point in history, when font changes are so easy to make and a bold font improves readability so much.
 
I agree with Richard that you should be trying to follow the same style guide in the release notes that you follow in your docs.

Ruth
 
------------------------------------------------------------
Ruth Sessions
603/886-7355

From: "Combs, Richard" <richard -dot- combs -at- Polycom -dot- com>
To: Nancy Allison <maker -at- verizon -dot- net>; "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Sent: Monday, July 18, 2011 11:53 PM
Subject: RE: Quotation marks around user interface labels

Nancy Allison wrote:

> Do you have a rule of thumb about using quotation marks for field
> names, dialog box titles, message text, and the like?

These kinds of things shouldn't be decided by rule of thumb, but by a style guide or template. Rules of thumb are too prone to be different the next time, when you're consulting your other thumb. ;-)

Our template (FrameMaker) has a defined character format that we use for GUI elements (labels, window/dialog names, etc.). It applies a specific bold font. Messages displayed to the user get a different character format, which italicizes them.

I realize a release notes doc is separate and distinct from a user manual, but I'd suggest using the same typographic conventions in each.

We don't use quotation marks for anything but references to other chapter/section titles in the doc. Personally, I think putting field names, etc., in quotes would make for busy-looking, cluttered text. But if that's what you do in the user manual and/or online help, do the same in the release notes. If not, don't.

In any case, I'd never mix the two conventions in the way Robert suggested.

IMHO, YMMV, etc.

Richard G. Combs
Senior Technical Writer
Polycom, Inc.
richardDOTcombs AT polycomDOTcom
303-223-5111
------
rgcombs AT gmailDOTcom
303-903-6372
------





^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days.
http://www.doctohelp.com

---
You are currently subscribed to TECHWR-L as ruthsessions03051 -at- yahoo -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/ruthsessions03051%40yahoo.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days.
http://www.doctohelp.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


References:
Quotation marks around user interface labels: From: Nancy Allison
RE: Quotation marks around user interface labels: From: Combs, Richard

Previous by Author: Re: Tips on how to talk to SMEs
Next by Author: Re: Quotation marks around user interface labels
Previous by Thread: RE: Quotation marks around user interface labels
Next by Thread: RE: Quotation marks around user interface labels


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads