CS-489

Implementation & Testing Document

The following is a suggested outline of topics to be included in the implementation and Testing document to be prepared for SW Engineering projects in CS-489. Remember that your audience for this paper is not just myself, but any other developer that may follow in your footsteps years later!

Title Page

Names of Team members

Date

Project Title, etc.

Abstract

A single-spaced paragraph, centered on a page, that summarizes the contents of the document. Include any key words that will tell the reader if he/she wants to continue to read your paper.

Table of Contents

Most Word processors can generate one of these automatically.

Introduction

Summarize the project history, inform reader of any background material that must be understood to proceed with the discussions to follow.

Implementation

Discuss the general approach your group has taken to implement the design that you proposed in the previous document. Were any of your design decisions retracted due to implementation difficulties? Discuss in detail, how things are handled by your implementation. Include a copy of the source code for the compiler in the appendix, complete with any appropriate comments, and annotate the key points of the working features with external documentation (which goes in this section of the paper). Discuss any other dependencies or subtleties that exist in your code.

Testing

Discuss the philosophy that you used to test your system. Discuss what unit tests that were performed on subsets of your prototype. Was there any integration testing conducted once the entire system was brought together as a whole? Are there any regression tests that could be performed? Include a copy of each of the test cases that you ran on your system, complete with the results of the test. Demonstrate examples of things that your system tries to do but fails, as well as things that it does do! This shows the limitations of the system’s capabilities. Verify, from your specifications, which of the requirements were met by the project and which were not.

Time & Defect Summary

Summarize the time logs that you’ve kept for the project. Indicate how much time was spent on activities in each phase of the lifecycle model (Analysis, Design, Implementation, and Testing). Indicate percentage-wise (pie chart) where the individuals and the team as a whole spent their time during the first phase of the project. Also summarize defect data. Indicate how many defects were found in each phase of the lifecycle process for phase 1. In each phase, how many defects were injected? How many defects were removed? Take an estimate at how many defects remain in the product. Is there a correlation between where time was spent and where defects were found?

Conclusions

In general, what was the result of your team effort over the first phase of the project? What things were accomplished by your prototype (any probe coding that you conducted). What things did not get accomplished? How might things be structured if the project were to continue beyond the allotted time frame? Did you stick to the elements of your original plan? What modifications had to be made?

References

Place a bibliography of all of your sources of information in this section. Once again, this can be easily done by standard commands in most word processors.

Appendices

Place all the unaltered artifacts and source files that you created into one easy set of readable listings here.