Re: Friday Poll Idea (WAS: In love with a word)

Subject: Re: Friday Poll Idea (WAS: In love with a word)
From: Janice Gelb <janice -dot- gelb -at- sun -dot- com>
To: TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 09 Jan 2006 10:15:38 -0800

Geoff Lane wrote:

On Monday, January 9, 2006, Nuckols, Kenneth M wrote;

>> Geoff Lane wrote:
However, when writing for an audience of mixed abilities, it is often
good practice to tell your readers how difficult a procedure is. FWIW,
I've done this with "spanner ratings" (the more spanners, the more
difficult) and with introductory text. Doing this helps readers
determine quickly whether specialist experience or resources are
required, and so whether to attempt the job themselves or call in
specialist help.

I'm going to disagree with Geoff on this. As TWs, our documentation
should be focused at a particular audience and we should write the
instructions accordingly. If we have to write a procedure for, let's
say, replacing the fan blades and bearings in an engine off of a Boeing
747 for an audience of holiday travelers, we should simply write the
procedure in such a way as to best allow a layperson (with the proper
tools) to complete the task.

Unfortunately, some people don't read through the instructions before
commencing work. These people might pass the point of no return before
discovering they haven't the skill or equipment to continue. At the
very least, a "spanner rating" at the start of the procedure might
alert the reader to such an issue and if they stop people from ruining
their day, such ratings are worthwhile.

You might lobby to have the "expert procedures" in a separate manual.
However, you probably wouldn't get far if the publisher's standards
demand one book per vehicle (as many do).

I still think it would be better to phrase the
differentiations in terms of the work experience
required or advised rather than in loaded terms
such as "easy" or "more difficult."

-- Janice

Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today!

Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author content and configure Help in MS Word or any HTML editor. No proprietary editor! *August release.

You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-
To unsubscribe send a blank email to techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit for more resources and info.

RE: Friday Poll Idea (WAS: In love with a word): From: Nuckols, Kenneth M
Re: Friday Poll Idea (WAS: In love with a word): From: Geoff Lane

Previous by Author: Re: re Contractions
Next by Author: Re: Gender neutrality and the multiple-personality third-person pronoun
Previous by Thread: Re: Friday Poll Idea (WAS: In love with a word)
Next by Thread: ADMIN Re: Friday Poll Idea (WAS: In love with a word)

What this post helpful? Share it with friends and colleagues:

Sponsored Ads