How to write software design documents?

The summary of the document should have been completed after the soft engineer. Before that, I had little feeling about writing a document. The master checked my documents and analyzed the problems in the documents and my situation, so that I could change the document. This time gave me a lot of new ideas about the document.

Why write a document?

This may be a question that many people want to ask. Why write a document? It is so trivial and troublesome before, after, and after. If you want to study a solution, you will have a meeting. Is it better to study and answer questions in person? It seems that the idea is good, but it is not. Perhaps our predecessors can also see that writing documents is troublesome. Why do we still need to write documents? First, the document is not just for developers. Maybe developers know a lot about the software, but what about those who have never touched the software? Sometimes, Do you think documents are like instructions for electronic products such as medicines or mobile phones? When buying medicine, I do not know about medicinal properties, do not know whether to take medicine or not, do not know whether the medicine has any side effects, whether pregnant women or children cannot eat, what is the dose, and so on, if there is a manual, then everything will not be solved? Second, the document can point out an established goal so that the design team can go in that direction without moving towards the deviation, which is helpful for the entire design team. Third, you must know that many projects need to be developed in cooperation, and one person cannot complete them independently. A large number of people gather together to complete their own tasks by performing their respective duties, and then "Assemble" their respective tasks to form an excellent software, what is the difficulty in this process. When many people gather together, the power is great, but their thoughts are open. If everyone follows their own ideas, the software and initial ideas developed at the end of the day will be, it is likely to be quite different.

What requirements should documents meet?

It is possible that you have never been familiar with the document before and are not familiar with its role and meaning. What requirements should documents meet? What kind of documents are qualified? Simply put, you get the document and follow the document to find the software that matches the document description. Such documents are qualified. Are the documents you wrote qualified?

My gains and experiences

I have learned a lot from the changes made to the document this time. Previously, the document template was used, regardless of the Primary and Secondary aspects, regardless of the focus, and "painted like a gourd ". As a result, the key points in the document are not written, and the key points should not be written in the past. When writing a document, you must focus on the specific part of the document, which cannot be ignored and should be focused on. This is the key to writing the document.

Important Notes for writing documents:Here are a few major examples. For example, when I write a summary Design Manual, what should I do? The outline design is the most important thing, of course, to describe the outline of the entire system in the document. Therefore, System Overview, software and hardware platforms, and the network architecture of the system are crucial. In the detailed design specification, the detailed description of functions should be emphasized on the basis of the summary design specification. For example, in the data center charging system, how does one perform on-board operations? You need to swipe your card or enter the card number and press the button on the machine to enter the card number. When you enter the card number, you need to specify the length, character specification, and how to obtain the card number. Detailed design documents are for programmers. To allow programmers who have never been familiar with the system to write code according to detailed design documents, the detailed design documents you have written are qualified. In the database design, the key is to write out the table attributes in detail, including the names of each table, the corresponding column names under each table, Chinese notes, numbers, lengths, and whether they are empty, whether the primary key, whether the foreign key, and so on. In the requirement analysis document, we should focus on analyzing the needs of end customers and the needs of the group for software performance and quality. In short, it is the most successful software to develop software suitable for the needs of the majority of users starting from the user's own. In the user manual, it is important to describe how to use the system, that is, the specific operation steps. Because the user manual is for the user, it is like a manual, it is a guide for the user to use. Users need to know what to enter, what to click, and what functions to accomplish. Operations can be ensured only when the user understands the operation.

The above section describes the analysis of documents. As documents are learned, new and good ideas will be found in the future and updated to the blog in a timely manner. You are welcome to give more valuable comments and make progress together!

For more information, see: http://ggddez.blog.163.com/