General Format:

Your lab reports are to be typed, single spaced, with normal one-inch margins. Be careful to have correct spelling and proper English grammar, as these will be taken into consideration when your report is graded. The sections of the laboratory report designated as required MUST be included in every lab report. Those marked as optional are required if so indicated in the laboratory assignment document. Printed copies stapled at the left-hand corner must be submitted in class on the due date. Remember that you must also email your programs to appropriate section account in addition to this report (details about emailing your programs will be provided separately).

Title Page (required):

Problem Specification (required):

Give a clear definition of the job to be done and the requirements that must be fulfilled. These requirements will be given in the assignment. You may use any parts of the lab assignment that you feel are needed, and you may wish to explain some points further.

Program Design (required):

Designing a solution for the problem that you are trying to solve will help you produce a good program. Therefore, the program design is an important step. This section must describe the approach you have taken to solve the problem described earlier. The exact method of design you will need to use cannot be generalized for all programs, so we will provide design issues with each assignment.

Testing Plan (required):

Testing is a planned process. You should think about how you are going to test your program before you even start writing any code. You need to think about where errors might occur, and how you can check to make sure that they don't. This section should explain those ideas as they apply to your program. You need to explain what items you tested and, how you chose your test cases, and how you decided what the expected outputs should be.

Test Cases (required):

The actual test cases that you use should be presented in a table form. For example,

Analysis and Conclusions (required):

In this section, you summarize the experiments performed, the results obtained, and provide a detailed analysis/evaluation of the results. You should include answers to the following questions: What does the result illustrate? If one algorithm is better than the other, what is the rationale for this? Did you achieve the goals or objectives of the lab? How did you achieve these goals (be specific). Looking back on the project what would you do differently? What changes would you make in the design phase of your project? What additions would you suggest to improve the working of your program. This is where we see what you learned from the project and access/evaluate the outcomes.

References: IMPORTANT

List ALL of the references you used in the assignment. This includes any classes that you used that you did not write and that weren't system classes, and any help you received from any other sources other than yourself, lab instructors, and course professors.

Feedback: (optional)

This is not a required section of your lab report, and in fact you can submit anonymously. However, if you wish to include this section we will certainly read and consider anything you tell us.
Informally tell us what could be improved in the lab.
Was it too difficult, or too easy?
Was the assignment fun or challenging?
Was there something that was unclear?
Was the project too long for the given amount of time?

Appendix A: Test Log

This section should contain the results of your testing phase. The test log should contain the test case number, the actual outputs, and the test result (either pass or fail). For example,

Appendix B: Source Code

This section should contain a printed copy of your program, complete with all necessary documentation. Be sure your comments accurately describe what is going on in the code.