RE: Display, Displays, or Appears

Subject: RE: Display, Displays, or Appears
From: "Dan Goldstein" <DGoldstein -at- riverainmedical -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 9 Jun 2008 17:18:35 -0400

"Repeated after every command"? Don't be silly. I begin each
manufacturing procedure with the following:

"If any step in this procedure returns an unexpected result:
* Stop working on the procedure.
* Write a note at the relevant step, including the unexpected result.
* Report the event to your supervisor."

If a window is not displayed when I say it should be, the employee using
the procedure knows what to do.

Descriptions of expected results are specific; responses to unexpected
results can be generic.

> -----Original Message-----
> From: Gene Kim-Eng
> Sent: Monday, June 09, 2008 5:08 PM
> To: techwr-l -at- lists -dot- techwr-l -dot- com
> Subject: Re: Display, Displays, or Appears
>
> I don't see how "The XXX window is displayed" does
> anything more in the event the window is not displayed.
>
> If it said, "The XXX window is displayed; if not see
> Section Z, Troubleshooting," that would account for
> the possibility of the window not being there, but who
> wants to see *that* repeated after every command in a
> manual?
>

This message contains confidential information intended only for the use of the addressee(s). If you are not the addressee, or the person responsible for delivering it to the addressee, you are hereby notified that reading, disseminating, distributing, copying, electronic storing or the taking of any action in reliance on the contents of this message is strictly prohibited. If you have received this message by mistake, please notify us, by replying to the sender, and delete the original message immediately thereafter. Thank you.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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-

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/archive%40web.techwr-l.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.


Follow-Ups:

References:
RE: Display, Displays, or Appears: From: Downing, David
RE: Display, Displays, or Appears: From: Downing, David
Re: Display, Displays, or Appears: From: Gene Kim-Eng

Previous by Author: RE: Display, Displays, or Appears
Next by Author: RE: Variety in Tech Writing (was: Display, Displays, or Appears)
Previous by Thread: Re: Display, Displays, or Appears
Next by Thread: Re: Display, Displays, or Appears


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


Sponsored Ads