Homework 4B, Homework 4 Design.
Short Description:
Complete the plan for the implementation of the project for homework 4.
This assignment is worth 10 points.
Goals
When you finish this homework, you should have:
- Turned your requirement document into a plan for implementing the project for homework 4.
The main goal of this assignment is to complete the plan for implementing the project for homework 4. You must use the design document template to describe your plan. Details relating to this document are here.
Formal Description
Use the design document template to document the final design of project four. This design will not contain any class information, structures, enumerated types or a UML diagram, so these sections of the template should be deleted.
The design should include a structure chart (see section 4.7 of the book). I prefer something like the structure chart shown on page 380. The intention is to show the interaction of the functions, not provide detailed information on function implementation. There are multiple tools for creating such a diagram (Smart Art in Word for example). The diagram should be part of your document, not a separate page stuck in the document.
Document all planned functions, including algorithm, interface and high level description. In the template, input are the input parameters to the function, not data input into the program. In the same way, output is data returned from the function, either as a parameter or a return value, not information written to the screen or a file. The narrative should be a short description of the task the function will perform, not an algorithm. For the most part this should be one or two sentences. The algorithm should be high level, not C++ code. The algorithm should provide sufficient details for high level testing.
This is a planning document, so I don't expect your design to match your final project 100%. It should, however, be a strong indication of the form of your final project. In this case, all or almost all of the functions in your final project should be described.
Discussion
- It might be advisable to write some small programs to test algorithms as you work on this project. This is not the final code, but well written functions at this stage might become part of the final code at some point.
- It might be advisable to continue to develop a set of test data for your final program. Again, this is not the final test data, but it will expand on the list developed in the requirements phase.
Required Files
A single document.
Submission
Turn in a printed document by the beginning of class on the due date. You need not three hole punch this document or put it in a binder but you must connect multi page documents with a staple or binder. (No paper clips please and no folding the corner to hold it together).
In addition, email a copy of this document to your instructor.