Documentation

Every project worth doing is worth documenting.

The following documents at least should exist for all software projects :

1.

User's Guide - a pedestrian's guide to how to use the software.

2.

Programmer's Guide - a programmer's guide to how the software has been written and how it works.

3.

Manual Pages - online descriptions of how to start the software and do basic things.

The accepted format for these documents is LateX and/or HTML.