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 -at- lists -dot- techwr-l -dot- com
Date: Sat, 24 Oct 2009 21:50:22 +1100

Chinell, David F (GE EntSol, Security) wrote:
> Kevin:
>
> Personally, your approach appeals to me. But I think you should also
> consider Sun's approach, which (if I interpret Read Me First! correctly)
> is to give NO special typographic treatment to GUI elements (or their
> identifying labels).
>
> When possible confusion exists between a label and the surrounding text,
> you can set the label in title case (though it may not be set that way
> in the GUI) or you can set it in double quotes.
>
> Click Back, and then check the "Use the security key color" check box.
>
> Click Back, and then check the Use the Security Key Color check box.
>

Actually, RMF does not call for double quotes,
either :-> It does indeed recommend no special
typographic treatment for GUI items.

Our internal Editorial Forum discussions on this
issue concluded that if you are writing a lot of
procedures involving a GUI, many items in the step
text would appear in alternate font, which means none
of the items would really stand out anyway. Plus,
although I have heard the argument that it makes the
steps easier to skim, frankly I'm not sure that we
really *want* users to just select options and click
buttons without reading any warnings or other
informational text in between.

Finally, too much alternate fonting can make text
look like a ransom note :->

-- 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.
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-

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


Follow-Ups:

References:
RE: Click X, or click the X button?: From: Claudine CHAUSSON
RE: Click X, or click the X button?: From: McLauchlan, Kevin
RE: Click X, or click the X button?: From: Chinell, David F (GE EntSol, Security)

Previous by Author: Re: Click X, or click the X button?
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