I'll stop now

Subject: I'll stop now
From: Ellen Vanrenen <ellen -dot- vanrenen -at- clear-technology -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 28 Sep 2001 10:30:09 -0600

Thanks for the sound advice.

I don't expect a single reply to this, but what got me frustrated are the
following paragraphs, which simply make no sense whatsoever to me:

Use the Task List for Writing Procedures

Another common form of documentation, the procedure or walk-through, depends
heavily on guiding the reader through steps to achieve a goal, One such
procedure might involve the installation of the software on a hard drive;
another would require setting the ....Procedures often include all the
options as well as shortcuts, warnings, and tips for avoiding common errors.

A thorough task list includes all these elements and makes them available to
the writer. When you write specialized procedures of a program -
installation tasks, configuration tasks - you rely very heavily on the
information in the task list.

and so on and so forth....

Tasks? Procedures? Steps? We just had a useless debate over whether a task
includes procedures, or a procedure includes tasks.

Sorry, didn't mean to waste your time. I just got frustrated. I promise to
behave better in future postings.

Ellen Vanrenen
Technical Writer
Clear Technology, Inc.
303-583-4170 (direct line)
ellen -dot- vanrenen -at- clear-technology -dot- com

____________________________________________________________________________
WARNING - THIS E-MAIL TRANSMISSION IS CONFIDENTIAL. This e-mail transmission
(including any accompanying attachments) contains confidential information
which is intended for the named addressee only. If you are not the intended
recipient, you are hereby notified that any use, dissemination, distribution
or reproduction of this e-mail is prohibited. If you have received this
e-mail in error please contact me immediately. Thank you.
____________________________________________________________________________


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

Planning to attend IPCC 01, October 24-27 in Santa Fe? Sign up by
October 3 and get a substantial discount! Program information,
online registration, and more on http://ieeepcs.org/2001/

+++ Miramo -- Database/XML publishing automation. See us at +++
+++ Seybold SFO, Sept. 25-27, in the Adobe Partners Pavilion +++
+++ More info: http://www.axialinfo.com http://www.miramo.com +++

---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.


Previous by Author: RE: Writing conventions
Next by Author: Re: Customers who read manuals from cover to cover
Previous by Thread: RE: Are we missed?
Next by Thread: Task, Procedure, Step


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


Sponsored Ads