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.
The fundamental difference here is that the barn, tree
and mailbox are all fixed in their locations and are not
going to just spring up out of nowhere when the driver
approaches them (and in this case, if they did it would
be a good thing to tell someone driving a car that such
a thing was going to happen unless you both lived on
a place like Toontown where things like this happen
regularly).
This instruction would be more analagous to telling
a user how to pick one of the commands on a menu
bar at the top of the window out from the others when
all are already displayed.
Gene Kim-Eng
----- Original Message -----
From: "Bonnie Granat" <bgranat -at- granatedit -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Sent: Tuesday, June 10, 2008 4:30 AM
Subject: RE: Display, Displays, or Appears
> It seems so basic to me, just like giving directions to Grandma's house:
> "After you reach the top of hill, you should see a huge barn on the left
> about 200 feet from the road. There's an enormous tree halfway between the
> road and the barn. Turn left at the mailbox."
>
> Would anyone consider that the above would not be helpful?
>
> Bonnie Granat
>http://www.GranatEdit.com
>
>
>> -----Original Message-----
>> From:
>> techwr-l-bounces+bgranat=granatedit -dot- com -at- lists -dot- techwr-l -dot- com
>> [mailto:techwr-l-bounces+bgranat=granatedit -dot- com -at- lists -dot- techwr-l
>> .com] On Behalf Of Ned Bedinger
>> Sent: Tuesday, June 10, 2008 6:00 AM
>> To: Downing, David
>> Cc: techwr-l -at- lists -dot- techwr-l -dot- com
>> Subject: Re: Display, Displays, or Appears
>>
>> Downing, David wrote:
>> > Lauren
>> >
>> > Okay, so you just refer to the window without explicitly saying it
>> > opened. That makes sense. However, I am still concerned about the
>> > situation where something goes wrong and the window isn't
>> displayed as
>> > it should be. You say that's outside the scope of the instructions
>>
>> Instructions fail if task analysis fails.
>>
>> Take the "Print" task as an example. Assume that you've ruled
>> out all of the peripheral print topics about changing toner
>> cartridges, installing, administering, configuring printer, ...
>>
>> You just want to write the procedure for the user who needs to print.
>> You know where the buttons that need clicking are. Have you
>> analyszed the task sufficiently to write a foolproof
>> procedure? Is a simple instruction telling how to locate and
>> click buttons enough for this task?
>>
>> Let's get serious about this. The user's goal in doing this
>> procedure is not to locate and click buttons. The procedure
>> is supposed to get something printed. Failure to accomplish
>> that, with results like walking down the hall to the printer
>> room and finding no printout, aren't what this procedure is
>> about, is it? It will be part of the result set if the
>> procedure abandons you before you before giving the result of
>> the print command.
>>
>> 1. Click the Print button.
>> The print job should appear immediately in the print queue.
>> For more information, see "Print Queues."
>>
>> IMHO, foolproof does not come easy, but stating what the
>> result is supposed to be, is cheap, graphic insurance that
>> you, at least, haven't sent your users down the hall for no
>> good reason.
>>
>> Ned Bedinger
>> doc -at- edwordsmith -dot- com
>>
>>
>>
>>
>>
>>
>>
>>
>>
>>
>> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>>
>> Create HTML or Microsoft Word content and convert to Help
>> file formats or printed documentation. Features include
>> support for Windows Vista & 2007 Microsoft Office, team
>> authoring, plus more.
>> http://www.DocToHelp.com/TechwrlList
>>
>> True single source, conditional content, PDF export, modular help.
>> Help & Manual is the most powerful authoring tool for
>> technical documentation. Boost your productivity!
>> http://www.helpandmanual.com
>>
>> ---
>> You are currently subscribed to TECHWR-L as bgranat -at- granatedit -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/bgranat%40g
>> ranatedit.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.
>>
>>
>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> Create HTML or Microsoft Word content and convert to Help file formats or
> printed documentation. Features include support for Windows Vista & 2007
> Microsoft Office, team authoring, plus more.
>http://www.DocToHelp.com/TechwrlList
>
> True single source, conditional content, PDF export, modular help.
> Help & Manual is the most powerful authoring tool for technical
> documentation. Boost your productivity! http://www.helpandmanual.com
>
> ---
> You are currently subscribed to TECHWR-L as techwr -at- genek -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/techwr%40genek.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.
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-