Re: Another Newbie question about procedures

[mearro -at- msn -dot- com]

I think that every step should relate to a user action. But a step doesn't
have to consist solely of that user action. So, although I handle this
type of information differently, I don't have an issue with the following
example:
3) Click the XXX button.
   The XYZ screen, as shown in fig 2-1 is displayed

As far as defining one action vs. two actions, I agree that's more of a
gray area. However, I've seen some fairly gross examples of this where
writers throw everything - including the kitchen sink - into one step. I
try to make my procedural steps (and writing in general) concise. I think
that most people want to scan numbered steps. By including *unnecessary*
details or combining what should *logically* be multiple steps into one
step, writers do a disservice to their readers.

That said, another pet peeve I have is the addition of the words "Now" and
"Then" in numbered steps. I'm not saying that these words should be
avoided entirely. I do have problems with their use in the following
example:
1) Click W.
2) Now click X.
3) Then you can click Y.
4) After completing step 3, you can click Z.  
Granted, this is a minor issue. But it does irritate me (hence the
reference to pet peeve ;). I mean, how many people try to complete step 4
before step 1? Can't we assume that our users understand that numbered
steps are sequential? (If your users are different & will follow steps out
of order without these directions - then by all means, you should include
them. You also have my genuine sympathy - it must be challenging to write
for this type of audience.)

Mary

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

New from Quadralay Corporation: WebWorks ePublisher Pro!
Completely XML-based online publishing. Easily create 14 online formats, including 6 Help systems, in a streamlined project-based workflow. Word version ships in June, FrameMaker version ships in July. Sign up for a live, online demo! http://www.webworks.com/techwr-l

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