On the importance of writing documents

After decades of development of modern information technology, people's lives and work are almost related to computers. For people who use computers often, writing documents becomes a necessary part of the job.

Document is the necessary information in software development use and maintenance, can improve the efficiency of software development, ensure the quality of software, and in the use of software has guidance, help, the role of doubts, especially in the maintenance work, documentation is indispensable information.

We not only write documents, but also write good documents, the documents we write must be detailed and clear, and the layout of the document must be in accordance with the specifications, so that others can clearly see the purpose of writing this document and the central idea.

If the quality control is not in place during the writing of the requirement document, the bug will naturally arise, and then the designer will design an inaccurate outline design and physical model based on the ambiguous requirements document, which is a huge loss for a project, so writing a high quality document can reduce the source of the bug. At the same time, when the requirement document writing conforms to the specification, the outline design is more clear and smooth, the code can be controlled more standardized and standard, increase the production efficiency of the code, improve the quality of the system. But once a poorly written document can lead to a lot of chain reactions, the cost is immeasurable, the loss is heavy, and the least willing to face it.

Documentation is the foundation of many system development processes, and only the correct and perfect documentation can be developed for smooth system development. So high-quality document writing is not a harm, and the importance of writing Pomelos must be taken seriously.

On the importance of writing documents