Software Design
Spring 2008

A few details about the final reports:

1) The final report is due at 11:59pm on Thursday 1 May.
Please check it in, in PDF format, to your group repository
(which should also contain all of the code for your project).

2) You will probably want to incorporate the material you
have already written into the final report, but you should
not turn in copies of the previous reports.  The final
report should be one coherent document.

3) For full credit, your report must have the elements
described in the project description document I gave you.
These are:

  * A final refinement of the design, including any changes
since the previous iteration and an explanation of why the change
occurred.

       (this section should include at least one UML diagram)

  * An analysis of the outcome.  Did you achieve your minimum
deliverable?  If not, why not?  Did you achieve your maximum
deliverable?  If so, what went right (that is, why was the project
easier to complete than you thought)?

  * A reflection on your design.  What was the best decision
that you made?  What would you do differently next time?

  * A reflection on the division of labor.  Were you able to
divide the project in a way that allowed the members of the team
to work independently and then integrate their work into a whole?

  * Bug report: what was the most difficult bug you had to find?
How did the bug manifest itself?  What did you do to find it?
How long did it take?  What was the cause of the problem?  In
retrospect, what could you have done to find it faster?

4) Please also include an overview of your code; that is, for
each file, please describe the contents of the file and how it
related to the other files.

Also (very important) please give me instructions on how to
run your program.  If there are any packages I need to install,
let me know.

Please make an effort to format your code so that it is readable.
Don't let lines of code or comments wrap around.  Use whitespace to
make the structure of the code clear.  Include appropriate comments.


Thank you.  If you follow these instructions carefully, it will
be easier for me to evaluate (and appreciate) your work.