CSE 143 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. You should be complete,
but concise. A report of only a couple of pages is fine if it covers all the
points, and 5-8 pages of text should normally be long enough.
Introduction
State the purpose of the project and give an overview of the application
to someone who is unfamiliar with it.
System Operation
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 an environment
like DrJava or Java command-line tools. Describe
how to run the program or how to create objects and interact
with them (whichever is appropriate). This part of the report should be
a "user
manual" that
describes how to use your program, without describing internal implementation
details.
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.) 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 and indented neatly.
But do not just dump all your
code
into the report. Describe
any code that you obtained from other sources (starter code, etc.)
that you used as part of your project.
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? If you added extra features to your project beyond the basic
requirements, describe what you did, how you learned about any concepts or
algorithms involved, and your experiences getting
them to work.
Describe your experiences with pair programming.
Did the pairing work well? Where
and when
did you
do the
work?
How did each
of you use your unique skills and abilities to contribute to the
project? Assess the relative contributions to the
project from each member of the team.
Testing and Evaluation
Describe how you tested and evaluated your application. If your application
does not meet the project requirements, please note these differences.
Include
representative
test cases and output, if appropriate. 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.
|
 |
Computer Science & Engineering
University of Washington
[comments to cse143-webmaster]
|
| 
UW Home 
