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: When to use the word "button" -- ? From:"Steve Janoff (non-Celgene)" <sjanoff -at- celgene -dot- com> To:Tony Chung <tonyc -at- tonychung -dot- ca>, "Porrello, Leonard" <lporrello -at- illumina -dot- com>, techwrl <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 25 Oct 2012 11:25:19 -0700
This happened recently. I was demoing some HTML5 help produced out of Flare, on the page that describes how to "get help" -- how to use the buttons in the help interface.
I had some inline images of the actual buttons, and the live buttons were on toolbars at the top and bottom of the page display, well above and below the text. The live toolbar buttons also had a "button" border whereas the inline images had no border.
Still, the person sitting at the PC started clicking the "image" buttons (dead ones) and saying, "Do these work?"
I just rolled my eyes (out of their view) and said, "Well, no...."
Steve
-----Original Message-----
From: On Behalf Of Tony Chung
Sent: Thursday, October 25, 2012 9:49 AM
To: Porrello, Leonard
Cc: techwrl
Subject: Re: When to use the word "button" -- ?
Haha I just joked about the cup holder at breakfast this morning. Hilarity
ensued.
That reminds me of a document my colleague wrote, where the application
screen shot figured prominently in the PDF. One of our end users just
wasn't able to get he system to work, so called us for help.
Turns out he or she was clicking the button on the screen shot, not in the
app.
If the screen image is in an online help, you could probably figure out
some magic to control the app... maybe?
-Tony
On Thursday, October 25, 2012, Porrello, Leonard wrote:
> Insert a screen capture of a button ONLY if you will NEVER need to
> translate and localize. We also mustn't forget that the "coffee cup in DVD
> tray" crowd may touch the "button" in the help and wonder why it doesn't
> work.
*********************************************************
THIS ELECTRONIC MAIL MESSAGE AND ANY ATTACHMENT IS
CONFIDENTIAL AND MAY CONTAIN LEGALLY PRIVILEGED
INFORMATION INTENDED ONLY FOR THE USE OF THE INDIVIDUAL
OR INDIVIDUALS NAMED ABOVE.
If the reader is not the intended recipient, or the
employee or agent responsible to deliver it to the
intended recipient, you are hereby notified that any
dissemination, distribution or copying of this
communication is strictly prohibited. If you have
received this communication in error, please reply to the
sender to notify us of the error and delete the original
message. Thank You.
*********************************************************
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Writer Tip: You have more time to author content with Doc-To-Help, because your project can be up and running in 3 steps.
See the “Getting Started with Doc-To-Help” blog post. http://bit.ly/doc-to-help-3-steps
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-leave -at- lists -dot- techwr-l -dot- com