Users Guide

. See the quick guide.

General layout for the Users Guide section of documentation. Documentation should consist of :

Product Description

• What is it ?
• What does it do ?
• What does it run on ?

How to use the product

Assuming that the system-wide setup has been done.

• Is there any kind of syntax needed per person ?
• What is the command line setup ? Are there any parameters or options ? Include some examples.
• Explain what commands appear within the program.
• Any other necessary and useful information.

How to install the product

• Obtaining the necessary files.
• Compilers required.
• Copying into system space.
• How to set a default home page.
• etc..