atw: Re: Steps and consequences

Thanks to all for your responses.  They've helped me clarify my own
thinking, and why I do as I do - and have provided a few alternate ways =
of
doing things that may help if I'm ever needing to negotiate a style
compromise!

- Naomi

-----Original Message-----

Getting back to the original question, Naomi, here's my take on it from =
a
non IT perspective. The format of procedures vary between disciplines, =
but
should always be clear on what the action is at each step and what the
consequence of that action will be.

Unlike IT disciplines, other disciplines do not usually have the benefit =
of
an obvious consequence shown on a GUI.  This is particularly so when
performing procedures on mechanical or electronic hardware. The =
consequence
of an action can inform the reader/operator/technician/whoever if the =
result
of the action has been successful.

For example:

     While configuring a digital display controller ........

     ACTION:                     Step 3.    From the SP6 Timer list, =
select
Repeat as the timer mode.

     CONSEQUENCE:                        The SP6 annunciator on the
controller is now flashing.

=20
-------------------------------------------------------------------------=
---
-------------------------------------

If the consequence statement was not there, how would the reader know if
their action had the desired result.

Cheers
John Bennett


**************************************************
To post a message to austechwriter, send the message to 
austechwriter@xxxxxxxxxxxxxx

To subscribe to austechwriter, send a message to 
austechwriter-request@xxxxxxxxxxxxx with "subscribe" in the Subject field.

To unsubscribe, send a message to austechwriter-request@xxxxxxxxxxxxx with 
"unsubscribe" in the Subject field.

To search the austechwriter archives, go to 
www.freelists.org/archives/austechwriter

To contact the list administrator, send a message to 
austechwriter-admins@xxxxxxxxxxxxx
**************************************************

Other related posts: