RE: Describing buttons and fields

Subject: RE: Describing buttons and fields
From: "Mike Hiatt" <mhiatt -at- vocaldata -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 4 Feb 2003 08:38:27 -0600

We have the ransom note. :-)

But we don't say - in most cases - "click the xxx button". In procedures, we try to consisently say "Click xxx" with xxx in bold. We use bold for field names, checkbox names, etc. Things we want to be sure whoever is using the procedure understands are things to look for in the GUI or buttons on a physical device (usually a telephone). Unfortunately, some of our field and checkbox names have lower case words in them.

Mike Hiatt
Manager, Tech Pubs
VocalData, Inc.
Dallas, TX (yep, that one)
mailto:mhiatt -at- vocaldata -dot- com

-----Original Message-----
From: Janice Gelb [mailto:janice -dot- gelb -at- sun -dot- com]
Sent: Monday, February 03, 2003 8:09 PM
Subject: Re: Describing buttons and fields

I wouldn't use quotation marks for GUI items. We only
use them in cross-references to chapters and sections.
I also recommend not using any kind of alternate font
treatment (like bold) for GUI items, as your procedures
then start to look like a ransom note. Just make sure
that your engineers use initial capitals for button and
field names and that should be sufficient to distinguish
them in steps, especially if you decide to add "the...button"
around the name.


Buy or upgrade to RoboHelp X3 today and receive the WebHelp
Merge Module for FREE ($299 value). RoboHelp X3's all-new
features include conditional text, completely re-engineered
printed documentation output, Context-sensitive Help Toolkit,
single-source layouts, and more!
Order online today at

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 for more resources and info.

Previous by Author: Re: Re: Any pharmaceutical tech writers out there?
Next by Author: RE: RoboPdf
Previous by Thread: RE: Describing buttons and fields
Next by Thread: RE: Describing buttons and fields

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

Sponsored Ads