Review the role of software engineering documents

(1)
Feasibility Study Report: Describe the technical, economic, and social feasibility of the implementation of the software development project, and comment on various possible implementation plans available to reasonably achieve the development objectives, describe and demonstrate the reasons for the selected implementation scheme.

 

(2)
Project Development Plan: Develop a specific plan for the software project implementation plan, which should include the person in charge of each part of the work, the development progress, the development budget, the required hardware and software resources. The project development plan should be provided to the management department and used as a reference for the development stage review.

 

(3)
Software Requirement Specification: Also known as the software specification, which provides detailed descriptions of the features, performance, user interface and operating environment of the developed software. It is an agreement between the user and the developer on the basis of mutual understanding of the software requirements and the basis for implementation and development.

 

(4)
Data requirements description: Data logic description and data collection requirements should be provided to prepare and maintain system data volumes.

 

(5)
Summary Design Manual: The work result of the summary design stage, the function allocation, module division, overall program structure, input and output, interface design, operation design, data structure design, and error handling design should be described to lay the foundation for detailed design.

 

(6)
Detailed Design Description: describes how each module is implemented, including algorithms and logical processes.

 

(7)
User Manual: describes in detail the functions, performance, and user interfaces of the software to help you understand how to use the software.

 

(8)
Operation Manual: provides the operator with relevant knowledge about the various running conditions of the software, especially the detailed operation methods.

 

(9)
Test Plan: the implementation plan for how to organize the test should be prepared for the Assembly Test and validation test. The plan should include the testing content, progress, conditions, personnel, selection principles of test cases, and allowable deviation range of test results.

 

(10)
Test Analysis Report: after the test is completed, a description of the execution of the test plan should be submitted. Analyze the test results and put forward the test conclusions.

 

(11)
Monthly Development Progress Report: the project progress report submitted by software personnel to the Management Department on a monthly basis. The report should include the comparison of the progress plan and actual implementation, the results of the phase, the problems encountered and solutions, and the plans for the next month.

 

(12)
Project Development Summary Report: after the software project is developed, it should be compared with the project implementation plan to summarize the actual implementation status, such as progress, results, resource utilization, costs and manpower invested. In addition, it is necessary to evaluate the development work and sum up experience and lessons.

 

(13)
Maintenance modification suggestions: after the software product is put into operation, if it needs to be corrected and changed, the existing problems, modification considerations, and modification impact estimates should be described in detail, submitted for approval. The above documents are prepared in a timely manner during the software life cycle with the development of various stages of work. Some of them only reflect the work of one stage, and others need to span multiple stages. Documentation prepared at each stage of software survival