Importance of documentation to the product

   It is a common problem for programmers to be lazy or unable to write documentation, but mature products should have good documentation. I, who have been doing product research and development, were recently exiled by the company to the project team to do the implementation work. Today, the client asked me to write a requirement specification, but I encountered a big problem. The content of the manual requires writing a system function structure diagram and a system function description. The system function structure diagram should be the content that must be included in the detailed design specification of the system. The product department of the company does not have a detailed system design specification. Because of the unfamiliarity with the system, if you want to write the system function structure diagram and system function description, you have to familiarize yourself with the system.
    Products may be used by many project teams. It would be a waste of time if everyone in each project team had to familiarize themselves with the system from scratch and then write a set of product specifications. It was a pain in the ass. Through this experience, I reminded me that when I make a product in the future, I should not only do a good job of system functions, but also pay attention to the writing of documents!

Guess you like

Origin http://10.200.1.11:23101/article/api/json?id=326680435&siteId=291194637