TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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-
