Overview of the analysis document template

Presentation

The analysis document template delivered as standard with Objecteering corresponds to a modeling procedure, which presents information in a particular form. This procedure is described below.

Class discovery techniques

Three main techniques are used to discover classes:

· the global approach: through flow diagrams between packages which represent the future system, we break this system down into sub-systems, and determine what represents, sends or receives the flows which designate classes in these sub-systems

· the dictionary: from terminology of the problem dealt with, provided in a dictionary, we define which model elements represent these terms

· needs approach: we identify users of the system represented by classes, and their needs represented by operations. We determine which model elements respond to these needs. Use cases (group of sequences which implement actors or users) are used at this stage.

Note: According to the nature of the problem, only some of these techniques may apply.

Principles of the analysis document template

The analysis document starts with a context overview.

Methodology entry points are presented: glossary or dictionary, analysis overview, definition of users and their needs (use case diagrams).

Analysis notions themselves, that is to say non "user" classes of the model, are developed. They are structured through packages.

The traceability between specified notions and retained entry points is provided: dictionary/model, users/needs, data flows/system notions.

Models used

"Actors", who represent users of the system, are distinguished from classes, which define the system.

This use case model describes needs.

The object model is used everywhere.

The operating model (pre/post-conditions, protocol state diagrams) is essentially used on interface classes.

The dynamic model is used on "actors", but very little on classes. We are more interested in "how do the users do" than in "how do the system's classes do". For classes, only the dynamic parts which are visible and important to users are represented. Sequence diagrams are used to describe use cases between objects.

Message files

The analysis document template uses an external messages file, which must be indicated in the document work product, so that the generation may suitably translate chapter titles. Two files ("analysis.us" and "analysis.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

1.1 Situation of this specification

1.2 Objectives of this specification

1.3 Reference documents

2 Preliminary specification

2.1 Dictionary

2.2 Overview of the application

2.3 Summary

3 Definition of the use cases

3.1 User packages

4 Detailed specification

4.1 Non-user packages

4.2 Classes

4.3 Interfaces

4.4 Referenced packages

4.5 Referenced classes

4.6 Referenced interfaces

5 Use cases

6 Examples

7 Collaborations

8 State machines

9 Activity graphs