Prof Ric Holt, Department of Computer Science,
BACKGROUND
This assignment is a follow-on from Assignment 1, in which the goal was to design the Software Architecture for your project.
CONSTRAINTS FOR THIS TERM
The following constraint is imposed:
GOAL
You are to produce a report that documents the Detailed Design of the software that you propose to develop. Your target audience is to be a junior programmer who is to implement your design as well as a manager or developer who is somewhat but not intimately familiar with your project. A junior programmer should be able to correctly implement any package or module given your Detailed Design.
Your report giving the Detailed Design is to be a companion document to go with your report on the Architecture. Ideally, you will repeat little that was already given in your Architecture report. At the same time, your Detailed Design report should, as much as reasonable, be a standalone document that can be read without the Architecture report.
REPORT
You report should include the following:
Title: About 3 to 6 words making clear what your report is about.
Authors: List of authors, their addresses, date, etc.
Abstract: About 2/3 of a page overviewing the key points in your report, targeted to a programmer, developer or manager.
Introduction and Overview: About 1 to 3 pages summarizing the purpose of report, its organization, and its salient conclusions. A person should be able to read just the abstract or just the introduction and have a good idea what is in the rest of your report.
Detailed Design:
Module specifications. You are to give, for each module, a clear specification for the module, such that a junior programmer can implement that module. The Detailed Design will include a clear description of the behaviour of the module and its externally visible interface. It will include a description of algorithms and data structures to be used and will describe non-obvious implementation techniques.
You should reference descriptions in your Architecture report of important patterns, classes abstractions, data structures or algorithms that are critical to the successful implementation of your system. Use diagrams as appropriate for this report. Do not include diagrams unless they are actually useful to the readers of you Detailed Design.
External Interfaces: Give details of information transmitted to/from the system, such as the Graphical User Interfaces, files, data bases, messages or networks. This should include menu design (if appropriate) and a clear specification of any details by which modules in the system transmit information to/from the external interfaces. If appropriate, give language-level interfaces to specify these methods. You do not need to include a discussion of feasibility studies.
Data Dictionary: Update the glossary in the Architecture report as necessary to include any new terms you are using.
Programming Conventions: List programming conventions that your programmers are required to follow, including conventions for naming classes, procedures and variables.
References: List any documents that your reader may wish to or need to read in conjunction with your report. Since the report is to be web readable, include links to references when appropriate.
DOCUMENT STYLE AND LENGTH
Document size. Do not make your report longer than necessary. In general, shorter reports that contain appropriate information are preferred. Your report must not be longer than 20 pages (in the hard copy version), including all diagrams and appendices.
Write clearly. Organize your report so it is easy to find things in it.
Design to minimize the need for documentation (while maximizing the simplicity and understandability of your system), without sacrificing necessary system performance.
FUTURE ASSIGNMENTS
The next assignment, number 3, is to implement this Detailed Design. Each implemented package or module is to include as comments its specification (given in this Detailed Design report).
In particular, each package or module should include a comment that gives the package or module specification. These comments in turn should be written so that they (and the items they define) can be mechanically extracted from the code.