Re: Use of Optional in instructions

Subject: Re: Use of Optional in instructions
From: Pro TechWriter <pro -dot- techwriter -at- gmail -dot- com>
To: Brian -dot- Henderson -at- mitchell1 -dot- com
Date: Mon, 14 Sep 2009 10:28:16 -0500

1. *Optional:* Select the *Tx Inhibit check box* to prevent the operator
from transmitting audio.

That's how we do it here, with DITA.

Hope this helps :-)

PT

On Fri, Sep 11, 2009 at 10:44 AM, <Brian -dot- Henderson -at- mitchell1 -dot- com> wrote:

> My question is: Is this first step optional, but step 2 is not? If so,
> I'd be more inclined to make that first step more like a Note, and the
> second step moved to first place...
>
> Note: The operator can be blocked from transmitting audio by selecting
> the Tx Inhibit check box.
>
> 1. Blah blah...
>
> -Brian H.
>
> -----Original Message----- From: Bruce Megan
>
> Hello Everyone,
>
> 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.
> http://www.doctohelp.com/SuperPages/Webcasts/
>
> 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!
> http://www.helpandmanual.com/
>
> ---
> You are currently subscribed to TECHWR-L as pro -dot- techwriter -at- gmail -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit
> http://lists.techwr-l.com/mailman/options/techwr-l/pro.techwriter%40gmail.com
>
>
> 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
> http://www.techwr-l.com/ for more resources and info.
>
> Please move off-topic discussions to the Chat list, at:
> http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat
>
>


--
“You can only become truly accomplished at something you love....Pursue the
things you love doing, and then do them so well that people can't take their
eyes off you.”

- Dr. Maya Angelou
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.
http://www.doctohelp.com/SuperPages/Webcasts/

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! http://www.helpandmanual.com/

---
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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


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
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


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

Previous by Author: Re: Misc: "The time has come," the Walrus said...
Next by Author: Re: Finding an open source project
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


Sponsored Ads