Computational Science & Engineering

Software Development Best Practice - Check List

CSED Group: ………………………………………………………………………………

Software/Project Name: …………………………………………………………………..

Contact/Auditor: …………………………………………………………………………..

Software Class: Prototype ¨ Project ¨ Product ¨

Software Age: Legacy ¨ Mature ¨ New ¨

Comments: ………………………………………………………………………………….

………………………………………………………………………………….

Best Practice Elements / Status / Comments
User Requirements Document
Management Plan
Software Quality Assurance Plan
Software Design Document
Test Plan
System Documentation
Test Report
User Documentation:
Project Web Site

Possible values of the Status: Complete, Partial or None

Add comments to clarify or justify current status.


The following table outlines which of these phases are appropriate for the different types of software development project.

Documentation / Prototype / Project / Product
User Requirements Document: / Essential / Essential / Essential
Management Plan / N/A / N/A / Desirable
Software Quality Assurance Plan / Essential / Essential / Essential
Software Design Document / Optional / Essential / Essential
Test Plan / Essential / Essential / Essential
System Documentation / Optional / Optional / Optional
Test Report / Essential / Essential / Essential
User Documentation: / Optional / Essential / Essential
Project Web Site / Optional / Optional / Essential

For a detailed description of these heading please read the CSED Software Development Best Practice (link of web page) document or refer to the Best Practice web pages:

http://www.cse.scitech.ac.uk/seg/html/wrap_best.shtml

Please feel free to discuss the completion of this audit with members of the Software Engineering Group.