Requirement:
There should be ``in-line'' documentation of the code.
Justification:
Allows to know what specific parts of code are doing.
Status:
Under discussion
Requirement:
There should be documentation on all routines by specification of a synopsis, a long description, a list of inputs and output variables (implicit and/or explicit), a list of possible return values, and a list of side effects.
Justification:
These information are meant to allow the user to consider the routines as black boxes with well defined inside/outside boundaries.
Status:
Under discussion
Requirement:
Notes that clearly explain the design, describe the algorithms that are used and explain the implementation must be provided.
Justification:
Justification of requirement
Status:
Under discussion
Requirement:
User's guide for the control subsystem will be generated.
Justification:
Justification of requirement
Status:
Under discussion
Requirement:
All the documentation should be generated along with the Control System Software.
Justification:
Justification of requirement
Status:
Under discussion
Requirement:
All the documentation must be readily available so that it can be found when needed. The SVT hardware control documentation will be added to existing hardware control documentation both under the HARDWARE CONTROL heading and under the SVT subsystem heading.
Justification:
Justification of requirement
Status:
Under discussion
Power supplies, air, water; On-detector temperatures, voltages; electronics temperatures, voltages; include needed interface software.