Re: Question about Options

["Robert L. Stallard \(News Lists\)" <rlslists -at- ev1 -dot- net>]

Greetings Gerry,

You wrote:
   > We're developing software with various optional
   > modules which users can purchase to increase the
   > functionality and scope of the product. We've been
   > told from above that the manual must cover all of the
   > options, regardless of whether the user has
   > purchased them or not. Yuck!
   >
   > So I'm interested in knowing what methods people
   > have used to distinguish optional components in the
   > text to users. I'm thinking it should be something that
   > is easily recognizable so they can learn it once and
   > then skip those sections that might not apply to them.

I am currently authoring a specialized hardware setup and installation guide
and an HTML help system for the accompanying software that has various
optional components.  Just like in your case, I am required to include
everything (including all options) in a documentation set that we will
deliver with the product, although not all options may be included.  We are
doing this so that customers may be enticed to purchase additional
components once they read about these in the documentation.

What I am doing is categorizing the information in sections around
modules/components/options.  I include the name of the module or option
either in parenthesis or indicated in the section heading itself.  When
applicable, I may include "(Optional)" --in parenthesis-- next to the
heading. This also assures that when I create the table of contents and
navigation tree, there is a clear indication of which are the optional
modules.

In addition to this, I include a note that clearly expresses it is an
optional component that the customer can purchase separately and I indicate
contact information.  I place these notes in a sidebar (in the margin) of
the page layout next to the beginning of the section.  For the help, I
defined unique paragraph and character styles for these notes.

I hope this helps you.  Have a great day!

Robert L. Stallard
Technical Writer
Houston, Texas, USA



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com

Sponsored by Cub Lea, specialist in low-cost outsourced development
and documentation. Overload and time-sensitive jobs at exceptional
rates. Unique free gifts for all visitors to http://www.cublea.com

---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot-  Visit 
http://www.raycomm.com/techwhirl/ for more resources and info.