CSE 142 Project Reports
Written Report Guidelines
Each student should complete a written report about the project individually.
The report helps you communicate technical ideas, while demonstrating your
knowledge about the design, development, and testing of the project code. Your
report should contain the information outlined below. Please use these guidelines
to prepare it.
The project report is an important component of the overall project, so you
should take the time to do a careful and thorough job.
Introduction
State the purpose of the project application and describe the application
to someone who is unfamiliar with it.
System Use
Describe how to use your system. Assume that the person using the
system has no familiarity with your code, but does know how to use the
interactions window in Dr. Java. Describe how a user can create objects in
your system and describe the important methods from a user's point of view.
Process
Describe how your team designed and implemented the project. What were the
interesting or challenging parts of the work? Did you need to make any significant
changes to your original design or implementation because of lessons learned
while doing it? Describe your experiences with pair programming. Did the
pairing work well? Where and when did you do the work?
System Description
Describe the structure of your system. What classes did you design and implement?
What are the important properties and responsibilities of these classes?
(Be sure to include significant changes you made to any starter code that
was supplied to you.) Describe the key algorithms and methods in your project.
Try to
describe the motivation behind your class design and examples of key algorithms
and methods. You might
find it helpful to include code examples in this part of the report. If you
do include code, be sure it is formatted neatly, possibly using a fixed-width
font like Courier. But do not just dump all your code into the report.
Testing and Evaluation
Describe how you tested and evaluated your application. If your application
does not meet the project specifications, please note these differences.
Include
representative
test cases and output. Evaluate the quality of your code - is it readable?
Are the properties and responsibilities of classes reasonable? Are there
things that you would do differently if you did the project over again?
Conclusion
What were the most important parts of this project and what did you learn
from it? This could include, among other things, technical issues, development
processes, or your experience working with a partner.
Remember, you will be graded on the clarity and writing style
of your report. Please be complete in your descriptions, but remember that
complete does not mean verbose.
|
 |
Department of Computer Science & Engineering
University of Washington
Box 352350
Seattle, WA 98195-2350
[comments to cse142-webmaster]
|
| 
UW Home 
