Software/Software Manual
The software should conform to the design document, have the software
components cross-referenced back to the design document, run well, and be
documented in accordance with the procedure given in the Software Manual.
The software team should cooperate with the:
- Configuration Manager to keep the software artifacts under configuration
and version control
- Requirements analysts in case questions arise as to whether certain
requirements can be implemented or other issue
- Designers in case prototypes need to be developed or questions need to be
answered as to whether certain design solutions are appropriate
- Testers so that the software can be tested thoroughly
- Documentation Specialists so that the user documentation can be written
well
The software team must use the following templates.
If any section is not applicable, leave the
section and replace the contents with "Not Applicable" along with the reason the
section is not applicable.
The Software Items Page is placed in the software directory and is the first
page displayed when that directory is accessed over the web..
Submitter: Lead Implementer
Document File Name:
- index.html (Software Page - this is for a different directory than for the
project artifacts)
- SoftwareManualMMDDYYYY.html, where MMDDYYYY should be the date of
submission to the project web site.
Software File Names:
As given in the Software Manual
Suggestions for small teams: Implement only the most critical or
desired requirements of the user, use only a programming environment that you
know how to use (You can spend a lot of hours learning how to use something and
put yourself behind schedule quick. Also, you will probably not complete
your project and have no or only a poorly executing program).