20160408 starting with 3 major documents for software engineering

The three major documents of software engineering can be divided into 3 phases: requirements, summary and detail.

One, requirements analysis document

The simple thing is to communicate with the guests and make the customer's business requirements a document.

The requirements analysis document can have use case description, the developer and the user fully communicate, use case diagram to express the guest's requirements, and use case diagram can make them agree.

Need to put some other things, such as performance description, non-functional requirements and so on

Two, outline design document

I think this is a good way to express myself as a person who is working at the forefront of the production at this stage, in turn summarizing the projects I have done. Reason to look down ...

First of all, the design of the audience is the project manager and guests, or as the outsourcing company and the communication basis for the party.

The preparation of the outline design document is to specify the system according to the requirements of the document. The function of the system is divided into modules, the hierarchy call relation of the module is established, the interface between modules is determined, the HMI and so on. (with the outline design, you can take him with the guests to blow water, to make a budget.) ）

The main content of the outline design,

1. Function description, can be presented by drawing a use case diagram
2. The main functional interface, you can refer to other projects, and then PS a bit.
3. The main architecture design of database, table design, the overall structure of the system (mainly refers to the package map)
4. Programming specifications

Three, detailed design

The main object of detailed design is the person who eventually writes the code.

The main content of the detailed design document,

1. Interfaces between the various layers of the system, such as classes, method names, parameters, return values, and so on.
2. System sequence Diagram (Sequence Diagram), can be said to be a system function sequence diagram, we can generally use UML interaction diagram to present, express the use case order behavior, (this is my short board, embarrassed). The developer can have a clear concept of the call relationship between the layer and layer of the system, the method name, the parameter, and the return value.
3. Other specific details, such as system accuracy issues, program graduation functions, performance descriptions, etc.

20160408 starting with 3 major documents for software engineering