Next: Test plan
and unit test report instructions
Previous: Preliminary Design instructions
Up: all milestones
CMPS115, Milestone 3
Detailed Design Document Instructions
Assignment due in lab: Develop a detailed design document (DDD) for your game.
- Design Decisions. List all decisions made about data structures.
Indicate which data is global (common to more than one module) and why.
This is worth 10% of the DDD points.
- Detailed Design. This is the second major pass at the code. The first
pass was created during the preliminary design phase. Include data and
code details. You may create this information in the form of
header comments (otherwise known as a prologue). At this stage of
development, it is quite common for groups to have a SUBSTANTIAL amount
of code started. It is not necessary for the code to compile. You can develop pseudocode for some of the more complex
modules and include it in the DDD. This part
of the detailed design is worth 50% of the DDD points.
- Tracing to the System Design (preliminary design - PDD).
List the mapping from the modules in the PDD to the modules in the DDD.
Typically there
are more modules in the DDD than you had in the PDD when the PDD
milestone was due. List the new modules' names. Make sure to include these
new modules in the preliminary design documents (I'm referring to the graphical
documents). Devise some way to identify the new modules when you modify
the PDD documents to maintain the consistency of your documents. For
example, you could highlight the newly added module names in your
design. Your goal here is to update the PDD to reflect changes made to
the preliminary (architectural) design while producing the DDD. This
is worth 30% of the DDD points.
- Group time recording log. This is worth 5% of the DDD points.
- Group meeting notes. This is worth 5% of the DDD points.
Next: TPUTR instructions
Up: all milestones
Acknowledgements: I would like to gratefully acknowledge Linda Werner, the author of this assignment.
Jim Whitehead
Last modified: Jan. 16, 2001