OPTION_A

What OPTION_A Controls

Spell out exactly what OPTION_A controls so that the reader understands the consequences of setting OPTION_A. Mention both direct and indirect effects.

Acceptable Values

Here specify what values the user can specify for OPTION_A. Present them consisely here and then elaborate on them later. For example

     Default: xxxxxx
     Format:  yymmdd
     Range:   Min: xxxxxx
              Max  yyyyyy
     Codes:   ABC = meaning of ABC
              CDE = meaning of CDE
              XYZ = meaning of XYZ

Default

Specify what value OPTION_A takes if the user fails to specify one.

Format

Precisely describe the required format for values specified for OPTION_A, for example:

                    +--- month (01=January, 02=February, and so forth)
                    |
                    |
                    ==
       OPTION_A = yymmdd
                  ==  ==
                  |    |
                  |    |
                  |    +--- day of the month
                  |
                  +--- year (95 = 1995)

Range

If values for OPTION_A must fall within a certain range, spell out that range, for example:

Maximum: xxxxx

Minimum: xxxxx

Codes

If the user must enter specific codes for OPTION_A, list those codes and their meanings. Or do the reverse. List the possible results and the codes that achieve each. For example:

   ==============================================================
   If you want to do this ...  |   Set OPTION_A= this code ...
   ==============================================================
     first possible result     |        ABC
   --------------------------------------------------------------
     second possible result    |        CDE
   --------------------------------------------------------------
     third possible result     |        XYZ
   ==============================================================

Example

Invite the reader to jump to the example of OPTION_A in use.