CS 2112 Fall 2018
Some programming assignments must be accompanied by overview documentation as described below.
You should format an overview document as either ASCII text (with lines at most 80 characters long), HTML, or PDF. The filename should be as specified on the CMS submission page with the appropriate extension for the file type (.txt, .html, or .pdf). Exercise good taste in formatting your document; the course staff value simplicity and readability over fancy graphic design. The typical length of an overview document should be two to four letter-sized pages, with 10–12 point font and reasonable margins. Use good judgment about what will be useful to the course staff while grading your assignment. Incomplete and excessive documentation will both be penalized.
An overview document should be structured as described below. You may omit sections that you find to be irrelevant for your assignment. The suggested word length of each section is a guideline, not a requirement.
Summarize the most noteworthy aspects of the rest of your overview. Anything you mention here should be described in more detail later in the document. You might include:
Sometimes you will need to resolve ambiguities or inconsistencies in the assignment specification.
Describe your finished specification. Identify the choices you made in finishing the specification, and provide a rationale for them. It might be useful to discuss alternatives you considered, why you rejected them, and the tradeoffs involved in your ultimate choice. If you made any changes to the given specification, justify why a change was needed and why the result of your change is reasonable.
Your job is to convince the course staff that your finished specification is reasonable and in the spirit of the assignment. If you are not convincing, the staff may deduct points.
Discuss how you created a program that satisfies the assignment specification. This includes topics such as:
Your job is to give the course staff enough information that we can understand your program, without needing to look at the source code, and to convince us that you thought carefully about the construction of your program.
Though the course staff may sometimes provide some test cases for you; it is almost always a mistake to think that those test cases are complete. The course staff often has a reserve of tricky test cases that your code will be tested against. Course staff tests are necessarily black-box tests that won't necessarily result in good code coverage. So spend time designing your own test cases. And don't wait until the last minute—do it early in the assignment, even before you've written any code.
Testing at the last minute is a recipe for failure. You should be testing your program incrementally as it is developed, starting as early as possible.
Describe and evaluate your test plan, and discuss any interesting issues that arose during the design of your test plan. Why do you have confidence that your test cases have enough coverage of the input space, and enough coverage of your code? Do your test cases accomplish both unit testing and integration testing? Include pointers to your tests.
Describe the results of carrying out your test plan on your program. Which of your test cases pass, and which fail? What systems did you test on (e.g., Windows, Linux, or Mac OS). If any of your tests fail, be sure to include a discussion of why you think they fail in the known problems section.
Claimed test case results that cannot be reproduced with your submitted code will be severely penalized and might even be an academic integrity violation. Never "fix up" the output of your program.
Your job is to convince the course staff that you exercised due diligence in validating your program.
If you work with a partner, explain how you are dividing up the work, and in what order you plan to develop the various project components. Justify why this plan will minimize the risk of redesign and allow you to test incrementally and continuously during the development process. Identify any key dependencies between different implementation steps, where one team member cannot start an implementation task until another team member has completed their assigned task.
Detail any known problems with your specification, design, or implementation. Problems that are clearly identified and described here will be looked upon more favorably than problems that the course staff discovers on its own. Are there bugs in your program? Missing functionality? Incorrect specifications? Incorrect documentation in the code? Let us know.
Express your opinions about the assignment. This section of the overview document will not be graded, but it earns good karma. We appreciate hearing your thoughts. You might address such questions as: