|
Section-by-section Format
-
The first page of the report must be the
title
page. It should be unnumbered. All subsequent pages are numbered starting
at 2.
-
The title page is followed by one or more
pages of Table of Contents.
-
The table of contents page is followed by
one or pages of List of Figures, asssuming that there are one or
more numbered figures in your document. Make sure that you number
the figures in the document sequentially from 1 oneards. Each figure must
have a caption and a number below it. Here is a sample:
Figure 3. Component diagram for Simulator..
-
The list of figures page is followed by one
or pages of List of Tables in case you have one
or more tables in your document.
-
Section 1 of the report is Introduction.
Various subsections in this section (a) state the purpose of this
report, (b) explain the need for the system under development by your team,
(c) provide a summary of the system requirements, and (d) give the
organization of this report.
-
Section 2 of the report is Overal Design.
This section summarizes the overall system design in terms of its
fundamental components and their interactions. Each component might
consist of one or more classes which are described in detail in the following
section. One diagram listing all thye compoennts and their connections
is usually sufficient to go with the text in this section.
-
Section 3, titled Classes and Objects lists
classes in your design, a description of each class, and at least one or
more class diagrams to illustrate the relationship amongst various classes.
There must be textual explanation of each class diagram. Use state
diagrams, when necessary, to explain the behavior of objects belonging
to a class. All associations and multiplicities must be explained with
explicit reference to the class diagram. Descriptions of various
classes should be in numbered subsections.
-
Section 4, titled System Behavior uses interaction
diagrams to explain collaboration of objects to achieve some system behavior.
Use as many diagrams as necessary to explain use cases Make sure that each
diagram is accompanied by a narrative and is referenced in the text.. Names
of use cases must conform to those used in the Requirements Document.
-
Section 5, titled Class packaging,
uses package diagrams to show how you propose to group different classes
into packages and how the packages will interact. This section is optional.
Number the subsequent sections appropriately if you omit this section.
-
Section 6, titled Test Plan, clearly describes
a test plan to test the program that will result when the design
is implemented. The subsections are to be titled Test Unit Specification,
Features to be tested, Approach for Testing, Test Deliverables, Schedule,
and Personnel Allocation. See the text for more details on what each
subsection should contain.
-
Section 7, titled Summary, is a summary
of this report. Limit it to one-half of a page.
-
Section 8 should be un-numbered and titled "Acknowledgements".
Use this to record your appreciation for the help that people from outside
your group provided in the preparation of this document. Your
grade will NOT be affected if the instructor's name does not appear in
here!!
-
Section 9 should be un-numbered
and tiled "Bibliography". It should contain a list of all books and
any other material you referenced to help you with your design report.
Organize the entries in this section using the format from the textbook
(p564 onwards). For each entry cited mention briefly why you referenced
that entry.
-
Appendix A, titled Use Cases contains a
summary of all use cases described in this report. This summary must match
the use case description in the requirements document.
-
Appendix B, titled Test Case Specifications,
lists at least one and preferably three, test cases for each unit to be
tested. For each test case the expected output must be specified. Use one
table to specify all tests cases for each unit to be tested. The table
should have two columns. The first column lists the test cases and the
second column provides the corresponding output. The output may be specified
in terms of values (e.g. 5) or in terms of a behavioral description (e.g.
"File myfile is opened"). Each table must be titled appropriately.
For example, a title could be "Test cases for class SEV".
-
Appendix C, titled Team Member Responsibilities
should contain a table listing each group member and the section(s) to
which they contributed in the preparation of this document.
End of Design Report Format
|