CS-489

Phase 1

Design Document Preparation

Date Due: Friday, October 6, 2000

The following is a suggested outline of topics to be included in the design document to be prepared for SW Engineering projects in CS-489. Remember that your audience for this paper is not just myself, but your clients and any other developer that may follow in your footsteps years later. One can add to this list, but the essential elements must be present in the final report.

The main objective of the Design Report is to map the requirements from the analysis document to the object-oriented design of the proposed system. Use Rational ROSE to diagram the identified abstractions (classes & categories), associations (uses, has-a, and is-a), properties, objects, accessibility, etc. The heart of the report will be descriptions of your modeling elements, represented in the form of conceptual models, sequence diagrams, collaboration diagrams, and any other artifact from the OOD process professed in the text by Larman.

The content of the report can be arranged into the following sections:

Title Page

Project Name

Names of Team members

Date

etc.

Abstract

A single spaced paragraph, centered on a page, that summarizes the contents of the document. Include any key words that will tell reader if he/she wants to continue to read your paper.

Table of Contents

Most Word processors can generate one of these automatically.

Introduction

A summary of the system requirements and the design proposed to address the problems at hand. Any background material necessary to understand the content of the document should be included here.

High-Level Design

Describe the abstractions made in defining the problem. This is where the conceptual model is presented and described. Remember, these diagrams are helpful in visualizing the design, but can by no means stand on their own. Describe your view of the design in terms that your readers can follow. Describe the role that each element plays in the design (all classes are abstractions, so describe the concepts that they represent in your system).

Detailed Design

Having given the high-level view of your system to your reader, go into fine detail as to the specifics of the system design. Describe all aspects of the elements in your sequence diagrams and collaboration diagrams. Discuss the design decisions made at this phase and indicate tradeoffs with other directions that could have been undertaken.

References

A bibliography of all of your sources of information. Once again, this can be easily done by standard commands in most word processors.

Appendices

Include the diagrams and specifications from the UML diagrams of your system model. List any source code or pseudocode, complete with comments, which describes the project to this point.

Note:

Submit your report (and any other pertinent information) via email to blessing@msoe.edu by the above due date.