13 documents required for software development

During software project development, thirteen types of documents should be written according to software development requirements. The documents should be specific, accurate, clear, complete, flexible, and traceable!

1. Feasibility Analysis Report

Describe the technical, economic, and social feasibility of the implementation of the software development project, and comment on various possible implementation schemes available to reasonably achieve the development goal, describe and demonstrate the reasons for the selected implementation scheme.

2. Project Development Plan

A specific plan should be formulated for the software project implementation scheme, including the person in charge of each part of the work, development progress, development budget, required hardware and software resources.

3. Software Requirement Specification (software specification)

The functions, performance, user interface, and running environment of the developed software are described in detail. It is written under the conditions that both users and developers have a common understanding of the software requirements and reach an agreement. It is also the basis for the implementation of development work. This manual should provide data logic and data collection requirements to prepare for the production and maintenance of system data files.

4. Summary Design Specification

This manual is the work result of the actual phase. It should describe the function allocation, module division,ProgramThe overall structure, input and output, interface design, operation design, data structure design, and error handling design provide the basis for detailed design.

5. Detailed Design Instruction

Focuses on how each module is implemented, including implementationAlgorithmAnd logical processes.

6. user operation manual

This manual describes in detail the functions, performance, and user interfaces of the software, giving users a detailed understanding of how to use the software and providing operators with relevant knowledge about the various operating conditions of the software, in particular, the specific details of the operation method.

7. Test Plan

In order to do a good job in integration testing and acceptance testing, we need to develop an implementation plan for how to organize testing. The plan should include the testing content, progress, conditions, personnel, selection principles of test cases, and allowable deviation range of test results.

8. Test Analysis Report

After the test is completed, a description of the implementation of the test plan should be submitted, the test results should be analyzed, and the conclusions and opinions of the test should be put forward.

9. Monthly Development Progress Report

This monthly report is 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.

10. Project Development Summary Report

After the software project is developed, it should be compared with the project implementation plan to summarize the actual implementation, such as progress, results, resource utilization, cost and manpower invested. In addition, it is also necessary to evaluate the development work and summarize the experiences and lessons learned.

11. Software maintenance manual

It mainly includes software system description, program module description, operating environment, support software description, and maintenance process description to facilitate software maintenance.

12. Software Issue Report

Identifies software issue registration information, such as date, discoverer, status, module of the problem, and provides the preparation documents for software modification.

13. Software Modification report

After the software product is put into operation, if problems such as modification and modification need to be discovered, a detailed description of the existing problems, modification considerations and impact of the modification should be provided and submitted for approval.