foreword
The document was completed on May 2, 2018, and the estimated value of 1 is casual (just kidding).
When the document is finished, it gives me the feeling that it is like what Mr. Mi said, swallowing the dates whole and the blind man touching the elephant. Because of the first contact, there are a lot of unaccustomed in the process of writing, holding other people's templates, reading and reading, writing and writing, and finally ended ignorantly, but after writing, it will definitely be better than I don't write strong, I dare not say that I fully understand each article, but each article is taken seriously!
Documentation benefits
I blogged about the "benefits" of documentation when I first came across it.
The benefits are many:
1. Clarify your thoughts
2. Problems will be found, so as to avoid the occurrence of problems and facilitate the review
3. Subsequent stages may be undertaken by others, and the documentation facilitates their work
4. Save time and cost, save money
5. Permanent
relation
The document is finished, but we still have to find the connection between the 12 documents, as shown in the figure:
A. Prepare documents: including feasibility study report, project development, software requirement specification, outline design specification, detailed design specification, database design specification, data requirement specification, test plan, and test analysis report. They are all prerequisites for project development. They are the foundation. Without these foundations, the project cannot be successfully developed, and it is also convenient for the management and maintenance of the project in the future.
B. Project development summary report: the design should be simple and easy to operate
C. Planning documents: including operation manuals, user manuals, and monthly development progress reports. These are created after the project is developed. They are like the instruction manual in a product, telling us how to use it, and it is also the perfect work for the project.
Epilogue
Before I could figure out how to write the epilogue, this morning I suddenly saw a message sent by our great God Bill on the WeChat Moments. I think this is God's will or that Bill has already thought up the epilogue for me. Thank you Bill, then It ends with his content:
Bill is a great god that everyone is familiar with and can no longer be familiar with. He is very powerful, and he told us the importance of documents not long after he joined the job, and also commented on the approval of Mr. Rimi, standing on the shoulders of two giants, I think There is nothing more authoritative than this. So we should be more serious about understanding and thinking about the importance of documentation! ! !
(Mr. Mi below is my comment, which is equally important!!!)