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:Chris Morton <salt -dot- morton -at- gmail -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Wed, 24 Oct 2012 10:00:25 -0700
Again, I think it depends on the audience. I'm writing for urologists using
our touchscreen interface. The majority are a very impatient lot (read: *prima
donas*) and any excuse to not adopt the use of our product in their
practice seems to be valid (to them), in that they've always performed
their duties using old school methodology and it's working fine (so they
think). (Here I wonder how long it took them to warm up to using
ultrasound.)
Having wrestled with this stylistic issue, I use "button" in these user
manuals, e.g., Touch the *[Gymfract]* button. Having a sense for their
collective mindset (judging from comments coming back to me from our field
reps), the physicians seem to need this extra bit of clarity.
In all other tw realms, I follow current practices and do not use the word.
Rather, the above would read Touch *[Gymfract]*, where the square brackets
and boldface serve as a visual clue that the manual is referring to an
oncreen button. Yes, I could explain this in a style guide at the front of
these current manuals, but none of them bother to RTFM anyway.
> Chris
On Wed, Oct 24, 2012 at 8:23 AM, Combs, Richard
<richard -dot- combs -at- polycom -dot- com>wrote:
> Craig Cardimon wrote:
>
> > "Click the Continue button to proceed."
> >
> > Or just:
> >
> > "Click Continue to proceed."
>
> Omit needless words.
>
> Richard G. Combs
> Senior Technical Writer
> Polycom, Inc.
> richardDOTcombs AT polycomDOTcom
> 303-223-5111
> ------
> rgcombs AT gmailDOTcom
> 303-903-6372
> ------
>
>
>
>
>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> 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 salt -dot- morton -at- gmail -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
>
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>http://www.techwhirl.com/email-discussion-groups/ for more resources and
> info.
>
> 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