atw: Re: Steps and consequences

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.

     
-----------------------------------------------------------------------------------------------------------------

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

Cheers
John Bennett

Carole Dacey wrote:

> Alex wrote:
>
> "I used to use the word "screen" in my doco until a colleague pulled me up
> and pointed out that "screen" was everything that the monitor displayed,
> whereas "window" was the actual application's display, so that's what I use
> now. In this case, I would say 'A new window opens' as part of step 1."
>
> My response:
>
> It's all in the eye of management when it comes down to it, isn't it?  We
> used to have "window dsplays" for the same reason your colleague stated.
> But now we are moving to .NET I have been over-ruled and "window" is
> replaced by "screen"!!  After a few abortive attempts at explaining the
> issue to management, developers etcI gave up - and my head no longer hurts
> from bashing against the verbal brick wall!
>
> Cheers
> Carole
>
> -----Original Message-----
> From: austechwriter-bounce@xxxxxxxxxxxxx
> [mailto:austechwriter-bounce@xxxxxxxxxxxxx] On Behalf Of Alex.Noon@xxxxxxxx
> Sent: Monday, 29 March 2004 3:21 PM
> To: austechwriter@xxxxxxxxxxxxx
> Subject: atw: Re: Steps and consequences
>
> Naomi
>
> I used to use the word "screen" in my doco until a colleague pulled me up
> and pointed out that "screen" was everything that the monitor displayed,
> whereas "window" was the actual application's display, so that's what I use
> now. In this case, I would say 'A new window opens' as part of step 1.
>
> Cheers
> Alex
>
> -----Original Message-----
> From: austechwriter-bounce@xxxxxxxxxxxxx
> [mailto:austechwriter-bounce@xxxxxxxxxxxxx] On Behalf Of Peter Fagan
> Sent: Monday, 29 March 2004 3:12 PM
> To: austechwriter@xxxxxxxxxxxxx
> Subject: atw: Re: Steps and consequences
>
> Naomi Kramer wrote:
>
> I'm needing thoughts and opinions. When writing steps to be followed, and
> the consequences, what format should be used? eg.  -
>
> 1.      Click OK
>
>         A new screen will be displayed.
>
> 2.      Enter the details
>
> OR
>
> 1.      Click OK
> 2.      A new screen will be displayed.
>         Enter the details
>
> **************************************************
> 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
> **************************************************
>
> **************************************************
> 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
> **************************************************


**************************************************
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: