Prepare your report using your favorite document processing system and add a link to  the HTML and/or postcript file to your Group page. Use 11 or 12pt Times New Roman for all text. Use a slighly larger point size for the high level section headings. For subsection headings use the same font size as that of the text. 
 

1. The first page  of the report must be the title page. It should be unnumbered. All subsequent pages are numbered starting at 2.

 
2. The title page is followed by one or more pages of Table of Contents.

 
3. 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. The TITAN message logging activity.  
4. 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.

 
5. Section 1 of the report is Introduction. This section  (a) states the purpose of this report, (b) provides reference to the requirements document that corresponds to this design document, (c) provides a roadmap of how to read this document. The roadmap will most likely  refer to sections of this document. 

 
6. Section 2, 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.

 
7. Section 3, titled "System Behavior-I", uses interaction diagrams to explain collaboration of objects to achieve some system behavior. Use as many diagrams as necessary to explain use cases. Sequence diagrams are preferred over collaboration diagrams. Names of use cases must conform to those used in the Requirements Document.

 
8. Section 4,titled  System Behavior-II", uses activity diagrams to illustrate activities that take place during the execution of the application. Use swimlanes to indicate the participation of classes in various activities. Concurrent activities must be clearly indicated and explained in the text.

 
9. 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.

 
10. Section 6, titled "Test Plan", clearly describes a test plan to test the  program that will result when the design is implemented. This section is to be divided into six numbered subsections as given on page 448 of the Jalote text. 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.

 
11. Section 7, titled "Summary",  is a summary of this report. Limit it to one-half of a page.

 
12. 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!!

 
13. 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 (PJ). For each entry cited mention briefly why you referenced that entry.

 
14. 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.

 
15. 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".

 
16. 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

Design Report (in 14pt, bold) 

Version 1.0 (in 12pt, plain) 
October 27, 1997 (in 12 pt, plain) 

Group number (A or B, in 12pt, plain) 

Names of group members, preferably in a tabular format.