Electronic Project Archive
The required contents is as follows:
"README"
file is in the root folder):
- | +-----> doc // documentation plus Report #3, presentation slides, etc. | +-----> design // UML diagrams | +--+--> code // project code | +-------> java // Java source code | +-------> classes // compiled Java classes | +-------> images // images and button icons | +-------> data // (database) files with example data | +-------> run // scripts and/or HTML files | +-----> tests // unit tests for the project code (and any other tests) | +-----> data // data collected or need for the project |
Each source code file should have at the top information about
the student who authored it or assisted in writing and debugging
the code, something like:
// written by: // tested by: // debugged by: // etc.The code will be compared with the diagrams in Report #3. The class, attribute and method names should exactly match. It is not necessary that these are consistent with Reports #1 & #2 since Report #3 revises and overrides the previous two. However, it is critical that the final UML diagrams in Report #3 and the final code are consistent.
A major factor in grading will be how well the code corresponds to
the UML diagrams. The class names, operation names, and attribute
names should exactly match. Put emphasis on consistency, neatness, and
completeness. For example, all exceptions should be properly handled.
Do not just catch an exception with empty braces:
catch(Exception ex) { }
.
Note that only negative points will be given if the electronic archive is missing some files/details or it is poorly prepared. The project electronic archive can reduce the overall project grade by 10% if some files/details are missing or it is poorly prepared. Include the breakdown of individual contributions in the reflective essay + peer evaluation after submitting the electronic archive.
See also the grading policy for the assigning the overall team grade vs. grades for the individual members.
The electronic archives will be graded as follows (note the negative points):
Points | |
(1) Any of the project reports missing | -3 |
(2) Demo slides missing | -1 |
(3) The recommended format for Electronic Project Archive not followed | -1 |
(4) Poor quality of code documentation a) Lack of correspondence between diagrams and code b) Poor code structure and readability c) Incomplete source code (e.g., missing files) d) Missing information about the student who authored/assisted/debugged on top of each file | -4 |
(5) Missing unit or integration tests | -3 |
(6) Inconsistency between the report printout and archive, checked in terms of module/class/attribute/operation names | -1 |
Note the grading focus on the correspondence between the diagrams and the quality of comments.
Package everything into a single ZIP file and upload to Blackboard submission folder. In cases where the file seems to be too large, you can upload the zipped file to your project GitHub repository. Kindly make sure the instructor has access to the GitHub repository, else all submission penalties will be applied.
Submission deadline: 11:59 p.m. (Central Time) on the due date.
BACK TO: