next up previous
Next: Code Documentation Up: Hardware Controls Previous: Actions

Documentation

Good documentation will be a key to smooth and efficient operation of the system. For a distributed group, like the STAR Controls containing many sub-group such as the SVT, the organization of a good information system is essential.

Requirement:

The subsystem development has to be well documented.

Justification:

Good documentation of the system developement allows new members to join and continue the work started by others so there is no need to regenrate from scratch parts of the system in case the author leaves the collaboration.

Status:

Under discussion

Requirement:

The hard implementation should be documented in details in connection with the software system.

Justification:

It is essential to know what the hardware is to understand what the software should do.

Status:

Under discussion



Claude Andre Pruneau
Thu Oct 12 18:01:54 EDT 1995