atw: Re: Steps and consequences

Hi Naomi,
I would: 
  a.. use the active rather than the passive voice;
  b.. number only the steps that the keyboard operator uses; 
  c.. use a font for the key tops as close as possible to the version on your 
keytops;
  d.. use clipart or images, such as screen capture shots to show what happens.
Have a look at any of the instruction manuals from the big players for 
examples. 
There is no official way, but there are standards that make operator uptake 
much simpler.

Regards,
Brian.
  ----- Original Message ----- 
  From: Andrea Tappe 
  To: 'austechwriter@xxxxxxxxxxxxx' 
  Sent: Monday, March 29, 2004 2:14 PM
  Subject: atw: Re: Steps and consequences


  My vote is for the former:
  1. Click OK.

     <i>The XYZ screen appears</i>

  2. Enter whatever....

  But that's just a personal preference! 

  Regards, Andrea

  -----Original Message-----
  From: Naomi Kramer [mailto:nkr@xxxxxxxxx]
  Sent: Monday, 29 March 2004 2:05 PM
  To: austechwriter@xxxxxxxxxxxxx
  Subject: atw: Steps and consequences


  Hey guys and gals,

  I'm needing thoughts and opinions again..

  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

  OR other options?  An 'official' way to do it, perhaps?  I'm severely
  lacking in proper tech writing tools here! :)

  - Naomi

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


  -- Attached file included as plaintext by Ecartis --
  -- File: InterScan_Disclaimer.txt

  This email and any attachments may contain privileged and confidential 
information and are intended for the named addressee only. If you have received 
this e-mail in error, please notify the sender and delete this e-mail 
immediately. Any confidentiality, privilege or copyright is not waived or lost 
because this e-mail has been sent to you in error. It is your responsibility to 
check this e-mail and any attachments for viruses.  No warranty is made that 
this material is free from computer virus or any other defect or error.  Any 
loss/damage incurred by using this material is not the sender's responsibility. 
 The sender's entire liability will be limited to resupplying the material.



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