Artifacts > Analysis & Design Artifact Set > Design Model > Report


Design-Model Survey
This report contains an overview of the Artifact: Design Model.

Role:

Designer

Reported artifact

Design Model

Purpose

This report describes the design model comprehensively, in terms of how the model is structured into packages and what classes are in the model. If you are using packages, the document shows the model structure hierarchically. The report can be used to describe the entire design model at different stages:

  • During elaboration, such as when you have identified the first classes and their objects.
  • During construction, when the design is complete.

This report is used by various people interested in the design model, such as the designers, testers, reviewers, and managers.

Brief Outline

1 Introduction

An Introduction to the design model.

2 Design-Model Hierarchy

This section presents the design packages hierarchically, explains the dependencies among them, and shows the content of each package recursively.

If the model has several levels of packages, those at the top-level are presented first. The packages within these are presented next, and so on, all the way down to the packages at the bottom of the hierarchy. For each package include:

  • Its Name.
  • A Brief Description.
  • A list of the classes owned by the package, including the name and a brief description of each class.
  • A list of the relationships owned by the package, including the name and a brief description of each relationship.
  • A list of the packages directly owned by the package, with each package presented in the same hierarchical manner as above.

3 Diagrams of the Design Model

The diagrams, primarily class diagrams, of the entire design model are included here. Note: These diagrams are not related to the use-case realizations or the architectural views of the model.

Feedback © 2014 Polytechnique Montreal