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:Robert Lauriston <robert -at- lauriston -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Fri, 23 Oct 2009 13:31:15 -0700
I use bold for anything the user has to click or select. I find help
formatted that way easier to skim.
When a menu choice or button label is not in intitial caps, I put
double quotes around it to distinguish it from running text.
On Fri, Oct 23, 2009 at 12:52 PM, Chinell, David F (GE EntSol,
Security) <David -dot- Chinell -at- ge -dot- com> 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.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-