Object Design Document
Authors
Title of Project
October 19, 2007
Contents
· Contents
· 1. Introduction
· 2. System Architecture
o 2.1 Topology
o 2.2 Data Stores
o 2.3 Software Control
· 3. GUI Description
· 4. Class Name 1
o 4.1 Attributes
o 4.2 Associations
o 4.3 Dynamic Behavior
o 4.4 Operations
· 5. Class Name 2
o 5.1 Attributes
o 5.2 Associations
o 5.3 Dynamic Behavior
o 5.4 Operations
· 6. Class Name 3
o 6.1 Attributes
o 6.2 Associations
o 6.3 Dynamic Behavior
o 6.4 Operations
· 7. References
o 7.1 Existing Software Documentation
o 7.2 System Documentation
o 7.3 Vendor Documents
o 7.4 Technical References
This section is an introduction to this document, basically an abstract of what is to follow in this document.
1. Introduction
This section is basically exactly what was in the System Design with corrections, modifications, or design changes added.
Describe in detail the design of the system architecture. Include what system topology will be used (layers, partitions, etc.) and what architectural framework will be used (client-server, interactive. etc.)
Describe in detail the Data Stores (files or external database) which are used by the system. Include BNF grammars or ER-diagrams were necessary. Describe the software control implementation of the system.
2. System Architecture
2.1 Topology
2.2 Data Stores
2.3 Software Control
This is basically exactly what was in the System Design with corrections, modifications, or design changes added.
Describe the Graphical User Interface. Include snapshots of sample screens as well as overall design decisions, and possibly a widget tree. Describe how you GUI design will be implemented in the object-oriented framework, include references to the OMT models that will contain the information.
3. GUI Description
For each object class completely describe the all aspects of the class. Include a data dictionary description of the class and all attributes of the class. Show and describe all associations to other classes in an object model and text descriptions.
Completely describe the dynamic behavior of the class, including diagram, and descriptions of each state. Describe how the control will be implemented for the class.
Completely describe the functional behavior of the class, including diagram, processing arrative, inputs, outputs, and algorithm to be used (in pseudo-code) for each operation of the class.
Include any other information that is specific to the class and to implementation, such as data store formats (BNF grammars), global resources, optimization techniques, justification of why particular algorithms were chosen, etc.
Once this description is completed for each class, the implementation WILL BE A SIMPLE TRANSFORMATION of the pseudo-code and attribute definitions into C++ syntax.
4. Class Name 1
4.1 Attributes
4.2 Associations
4.3 Dynamic Behavior
4.4 Operations
5. Class Name 2
5.1 Attributes
5.2 Associations
5.3 Dynamic Behavior
5.4 Operations
6. Class Name 3
6.1 Attributes
6.2 Associations
6.3 Dynamic Behavior
6.4 Operations
This section should contain the sources of any and all references to other group documents, articles, books, etc. that you used in creating this document. Those interested can replace this with a true bibliography.
Please see the TA if you wish to learn how to create bibliographies.
7. References
7.1 Existing Software Documentation
7.2 System Documentation
7.3 Vendor Documents
7.4 Technical References