Re: Use of Optional in instructions

Subject: Re: Use of Optional in instructions
From: "Gene Kim-Eng" <techwr -at- genek -dot- com>
To: "techwr-l List" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 11 Sep 2009 08:48:49 -0700

If your readers have a habit of not reading the entire instruction, than the
SME's argument is valid. Vincent's suggestion could help, or you could
rewrite the instruction to say something like "If you want to block the
operator from transmistitng audion, select the Tx Inhibit check box."

The next question is, do you need to explain to the reader why one might or
might not want to use this, or is this something your readers will all know?

Gene Kim-Eng

----- Original Message -----
From: "Bruce Megan (ST-CO/ENG2.2)" <Megan -dot- Bruce -at- us -dot- bosch -dot- com>
> An interesting debate has started at my workplace... is the following
> use of "optional" acceptable? If not, any suggestions on other ways to
> 1. Select the Tx Inhibit check box, to block the operator from
> transmitting audio (optional).
> A SME has put forth the argument that a user may not catch the
> (optional) due to not reading the entire instruction.


Free Software Documentation Project Web Cast: Covers developing Table of
Contents, Context IDs, and Index, as well as Doc-To-Help
2009 tips, tricks, and best practices.

Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control!

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Please move off-topic discussions to the Chat list, at:


Use of Optional in instructions: From: Bruce Megan (ST-CO/ENG2.2)

Previous by Author: Re: Illustrations to be printed; was: Re: Viso/Office guru?
Next by Author: Re: Question - Training Guides - Who Writes?
Previous by Thread: Re: Use of Optional in instructions
Next by Thread: Re: Use of Optional in instructions

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

Sponsored Ads