RE: Use of Optional in instructions

Subject: RE: Use of Optional in instructions
From: "Phillips, Wanda" <wanda -dot- phillips -at- philips -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 15 Sep 2009 21:44:07 +0200

Generally, we use the topic title to indicate a larger goal (Measuring the Need to Reply) and then within the instructions choices, optional actions, and required actions are handled differently.

Choices are listed (Perform one or more of the following:), optional actions begin with the goal (To include more respondants, do this.) or an indication of the optional status (If required, If desired), and required actions are simply stated (Select the names from the x list.)

We do, for regulatory reasons, include descriptions of every control, option, and piece of equipment and we do describe *every* OK click for much the same reason.

Wanda Phillips
Senior Technical Writer

Don't be afraid, Jellybean: Quod non est in actis, non est in mundo


The information contained in this message may be confidential and legally protected under applicable law. The message is intended solely for the addressee(s). If you are not the intended recipient, you are hereby notified that any use, forwarding, dissemination, or reproduction of this message is strictly prohibited and may be unlawful. If you are not the intended recipient, please contact the sender by return e-mail and destroy all copies of the original message.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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


Follow-Ups:

References:
RE: Use of Optional in instructions: From: Combs, Richard
RE: Use of Optional in instructions: From: Boudreaux, Madelyn (GE Healthcare, consultant)
Re: Use of Optional in instructions: From: Robert Lauriston
Re: Use of Optional in instructions: From: Gene Kim-Eng

Previous by Author: RE: Misc: "The time has come," the Walrus said...
Next by Author: RE: Review process for online help
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