Re: Use of Optional in instructions

Subject: Re: Use of Optional in instructions
From: Robert Lauriston <robert -at- lauriston -dot- com>
To: techwr-l List <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 11 Sep 2009 09:43:40 -0700

To me, the logical and grammatically correct way to present such
instructions is to explain the choice, then provide the instructions.

"If you wish to view the generated code now, click *Preview*."

If I figure that most users won't need any explanation, I might put
the explanation at the end:

"If appropriate, set a *Timeout* value (a number of minutes after
which the transaction will be rolled back if the script has not
completed)."
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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: Gene Kim-Eng

Previous by Author: Re: Changes in MIF output in FM 8.0
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


Sponsored Ads