Re: Click X, or click the X button?

Subject: Re: Click X, or click the X button?
From: Janice Gelb <Janice -dot- Gelb -at- Sun -dot- COM>
To: techwr-l List <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 23 Oct 2009 08:10:08 +1100

jennysubs -at- mac -dot- com wrote:
> How do you describe button actions? Does it make a difference if
> you're writing online help vs. print/PDF?
> I was trained to use the full "click the XYZ button," but recent style
> seems to be "Click XYZ."

Our house style says that if it's a common button
name like "OK" you can just say "Click OK." However,
if it's not a common name, you should say "the XXX
button." If you have established a button name used
in the application with "the XXX button" you can
eliminate the surrounding phrase on subsequent use.

-- Janice

Janice Gelb | The only connection Sun has with
janice -dot- gelb -at- sun -dot- com | this message is the return address

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.

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!

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

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

Please move off-topic discussions to the Chat list, at:

Click X, or click the X button?: From: jennysubs

Previous by Author: Re: Documentation confidentiality level policy
Next by Author: Re: Click X, or click the X button?
Previous by Thread: RE: Click X, or click the X button?
Next by Thread: Re: Click X, or click the X button?

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

Sponsored Ads