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: my bad displays habit From:John Posada <jposada99 -at- gmail -dot- com> To:jennysubs -at- mac -dot- com Date:Tue, 2 Mar 2010 15:50:58 -0500
Don't get me wrong...if I have a procedure of X number of steps, I
won't include the results for every step...only if the state of what
they see changes, either a new screen, actionable dialog, etc.
if nothing visible changes, there is nothing to describe.
I've also, for the last two years been doing online help topics and
now, knowledgebase material for Vonage customers and phone
customer/technical support personal.
On Tue, Mar 2, 2010 at 2:10 PM, <jennysubs -at- mac -dot- com> 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 dialog 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.
> On Mar 2, 2010, at 10:32 AM, John Posada wrote:
>> I'm in the camp of including the results.
>> It's not that my users are surprised that "something" displays...it's
>> that I want them to know that the right thing displayed.
>> The way I see it, if you don't tell them what should be displayed,
>> then ANYTHING that displays is the correct thing to display.
> 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:
> You are currently subscribed to TECHWR-L as jposada99 -at- gmail -dot- com -dot-
> To unsubscribe send a blank email to
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit http://lists.techwr-l.com/mailman/options/techwr-l/jposada99%40gmail.com
> To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>http://www.techwr-l.com/ for more resources and info.
> Please move off-topic discussions to the Chat list, at:
Senior Technical Writer
NYMetro STC President
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-