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: Re: my bad displays habit From:"Gene Kim-Eng" <techwr -at- genek -dot- com> To:jennysubs -at- mac -dot- com, techwr-l -at- lists -dot- techwr-l -dot- com Date:Tue, 2 Mar 2010 20:48:51 +0000
In a situation where I concluded this was necessary, I would probably prefer to use either:
1. Click on the big red button.
2. In the big red dialog box, do the next step...
or
1. Click on the big red button to continue to the big red dialog box.
2. Do the next step.
I would definitely use the latter if the user had multiple options (big red button, big blue button, big green button, etc.)
Gene Kim-Eng
------- Original Message -------
On 3/2/2010 7:10 PM wrote:
Just to provide yet another way to say this...
I worked where the company style was to say "You see the XYZ dialog" if you felt it was important to tell them what they were seeing.
It did keep the focus on the reader rather than the program. I found it a bit awkward at first, but got used to it.
1. Click the Big Red button.
You see the Big Red dial og box.
2. Type .....
Now, I usually just don't tell them. Depends on the audience though. I write mostly for geeks, who are annoyed by the obvious.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Use Doc-To-Help's XML-based editor, Microsoft Word, or HTML and
produce desktop, Web, or print deliverables. Just write (or import)
and Doc-To-Help does the rest. Free trial: http://www.doctohelp.com
Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free at: http://www.ModernAnalyst.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-