Overview of the design document template

Introduction

The design document template uses an external messages file. This file has to be defined in the document work product, so that chapter titles can be properly translated during generation. Two files ("design.us" and "design.fr") are delivered as standard, to generate documentation in English or French. You can also define your own titles by creating a new message file.

Contents

1. Overview

Situation of this design document

Aims of the technical design

Reference documents

Dictionary

2. Architecture

Implementation constraints

Technical architecture

Implementation principles

3. General design

Description

Essential elements of this design

Use cases

Examples

Collaborations

State machines

Activity graphs

Sub-systems

Packages

Classes

Interfaces

Components

Nodes

Referenced packages

Referenced classes

Referenced interfaces

Referenced components

Referenced nodes

4. Traceability

5. Integration