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:Lynne Wright <Lynne -dot- Wright -at- tiburoninc -dot- com> To:"Porrello, Leonard" <lporrello -at- illumina -dot- com>, Craig Cardimon <craig -dot- cardimon -at- gmail -dot- com>, techwrl <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 24 Oct 2012 16:20:14 +0000
??!!??? really?
That's way too verbose to describe a simple, standard action. And if the user is that much of a novice they probably won't know what "hover" implies; plus it doesn't cover the fact that most mice have a left and a right button as well as a scroll wheel.
Even though I would hope that a user would know how to click a mouse before they sit down to learn an application, our manuals have a Conventions section up front where we define what Click, right-click, and drag and drop mean. And if they still can't figure out those actions, they're just going to have to ask somebody to show them. No way I'd write to that level of detail in every step of every procedure.
Actually, given that we only deliver electronic versions of our manuals now, maybe I should take that Conventions section out... because they won't be able to access the pdf or online help files unless they already know basics like how to click!
-----Original Message-----
From: techwr-l-bounces+lynne -dot- wright=tiburoninc -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+lynne -dot- wright=tiburoninc -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Porrello, Leonard
Sent: Wednesday, October 24, 2012 11:57 AM
To: Craig Cardimon; techwrl
Subject: RE: When to use the word "button" -- ?
I prefer "Click Continue to proceed." (With "Continue" bolded.) But again, it depends on audience. If your audience is still trying to use the DVD tray as a cup holder, then more explicit may be better. On the other hand, chances are that if your audience can't infer that Continue is a button, they'll be equally at a loss to understand "click". So really, if you are going to use the more explicit form, you should say something like, "1. Use your mouse to move the arrow cursor on the screen so that it is hovering over the Continue button. 2. With the cursor hovering over the Continue button, click the mouse to select the Continue button." And this concludes today's exercise in reductio ad absurdum.
-----Original Message-----
From: techwr-l-bounces+lporrello=illumina -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+lporrello=illumina -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Craig Cardimon
Sent: Wednesday, October 24, 2012 8:13 AM
To: techwrl
Subject: When to use the word "button" -- ?
I am staring at Apply, Continue, Cancel, and Save buttons, wondering if I should say:
"Click the Continue button to proceed."
Or just:
"Click Continue to proceed."
Opinions?
--
Cordially, Craig Cardimon - "The Duct Tape Tech Writer" (Docs Wrapped & Shipped. Deadlines Beaten.) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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 lporrello -at- illumina -dot- com -dot-
To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com
Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com
Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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 Lynne -dot- Wright -at- tiburoninc -dot- com -dot-
To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com
Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com
Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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
