How to Design the architecture and write the architecture design documents

1. Read ieee1471.
2. Some of my experiences in writing documents:
Writing of Modern Architecture Design Documents

The 4 + 1 view and UML Software Architecture Design have gradually become the core of the modern software development process. However, it is clear that architecture design is not an easy task. For object-oriented development, the 4 + 1 View of RUP has been widely used and recognized in architecture design.

There are several different versions of the 4 + 1 view description (or the included view is different, or the view name is different). In this article, the 4 + 1 view proposed by philpe kruchten and November 1995 prevails.

The 4 + 1 view includes logic view, development view, process view, physical view, and scenario view ).

Relationship between views

The 4 + 1 view not only facilitates us to record the architectural design, but also guides part of our architectural design activities.

We usually choose UML to present various views. The following lists the UML ing between UML and various views.

4 + 1 view UML

Scenario view use case

Logical view class diagram

Development View class diagram, component Diagram

The process view does not have a full correspondence

Deployment View

In architecture design stability, a large number of case descriptions are usually not provided, which are defined in demand stability. However, some use cases are often selected in the architecture document and included in the document. These use cases are used together with some non-functional requirements to prove the effectiveness and correctness of the architecture. In the logical view, the implementation of use cases is indispensable, although the architecture design focuses more on non-functional requirements.

The idea of integrating with MDA often finds it difficult to distinguish between the logic view and the development view. The logical view contains more analysis models and implementation technologies, such as the business object model and its extension. The development view is closely related to the implementation technology.

With the promotion of the idea of MDA, the writing of architectural design documents has also had an impact. It is not difficult to associate the PIM of MDA with the logical view, in contrast, we associate the SMS in the MDA with the development view.

When writing a logical view, we should describe the model irrelevant to the technical platform, while the Development View describes the Model Related to the implementation technical platform.

For example, some entity classes displayed in the logical view, we will switch to the EJB component (Entity Bean) in the development view ).

This approach not only helps us to write architecture design documents, but also provides a good architectural design thinking process.