SE450: Requirements: Report [9/16] Previous pageContentsNext page

Thirty percent of your grade is based is based on a written report. Although no specific style guidelines are being enforced, the report must be presented in a neat, legible, and consistent format.

All text must be typed. Diagrams may be hand-drawn; however they must be neat, ie, drawn with a ruler. DL students may scan hand-drawn diagrams. The diagrams should conform to the UML notational conventions presented in class.

The written report should be structured as follows:

  1. Title page with your name at the top.

  2. Class diagrams for each package. Include a design class diagram for each package in your your project. Be sure to include all significant class relationships: realization, specialization, and association. Show associations as dependencies, aggregations or compositions when appropriate. Show attributes and methods only if they are crucial to understanding the class relations.

    Do not use tools that automatically generate diagrams from your code. The diagrams they produce are unreadable.

  3. Sequence Diagram. Draw a sequence diagram indicating the how a car updates its position. Show all the objects involved.

  4. Time Summary. Provide a table breaking down the amount of time (in hours) you spent each week in the three areas. The table should look like this:

    Week    | 1 | 2 | 3 | 4 | Total
    Design  |   |   |   |   |
    Code    |   |   |   |   |
    Bigbug  |   |   |   |   |
  5. Notes on patterns. Indicate the design patterns used in your project. For each pattern, note the specific problem in your project that the pattern solved. Also indicate the classes involved and briefly discuss the implementation of the pattern. These notes should take 1 to 2 pages.

  6. Successes and Failures. Discuss what went right with your project? What went wrong? Note design issues that arose during development, such as specific decisions, use of design patterns, failures, successes, etc. This should take about 1 page.

Previous pageContentsNext page