[ Online Instructions ] [ Assignments ] [ Syllabus ] [ Online Resources ] [ Examples ] [ Lecture Notes ] [ Class Updates: ] [ Project Format ]

Project Report Format

For each project, you will owe me a report.  By its nature, project grades will be somewhat subjective.  For the report itself, I will be looking for the following components.

Very important!!! A statement of what borrowed code has been used in the project, and how your code differs from the borrowed code is required. Percentages of original and borrowed code would be helpful.  If you borrow code,
make sure you reference where it came from.  This is a place where you can lose a lot of points.

Your Reports should include::

1. A figure illustrating your software design, and an written description of the design. Discuss your plan for modularity, exception handling, and user interface. Your figure should use UML (Unified Modeling Language). Individual sections in the report might be labeled:
   a) Introduction
   b) Summary of the Design
   c) Modularity
   d) Exception Handling
   e) User Interface
2. Make sure that you highlight the unique features of your code. If you went beyond the basic functionality, then,
   it is important that you make this clear to me, and explain it fully.
3. A history of the versions you produced and your debugging process. In other words, a log of how many versions you went through, and the problems you encountered. Present in a Table format.
4. A log of the testing of the code that you did and the results of those tests. Again, in a Table format. This should include the platforms on which you tested your software.
5. A "man" page for your software, with operation instructions and syntax. This basically what I would need to run your software without you being present. You are free to chose how your present the manual. What I want is a clear explanation of how to run your code.
6. The well-documented source code.
7. As always, spelling, grammar, neatness, organization, and presentation count.

For grading and more information, refer to syllabus and table below.  Weighting in table should give you an approximate idea of relative importance of each component, but  I want to stress the subjectivity of the grades.

[ Back ] [ Home ]