The role of various documents in the software development process

In the process of software project development, 13 types of documents should be written in accordance with the requirements of software development, and the documentation requirements must be targeted, accurate, clear, complete, flexible, and traceable!
  Requirement stage
  1. The feasibility analysis report
  explains the technical, economic and social feasibility of the software development project, reviews various possible implementation options that can be selected in order to reasonably achieve the development goal, explains and demonstrates Reasons for selecting the implementation plan.
  2. Project development plan
  Work out a specific plan for the software project implementation plan, which should include the responsible personnel of each part of the work, development progress, development budget, required hardware and software resources, etc.
  3. The software requirement specification (software specification)
  gives a detailed description of the functions, performance, user interface and operating environment of the developed software. It is written under the conditions that both users and developers have a common understanding of software requirements and reached an agreement, and it is also the basis for the implementation of development work. The manual should provide various requirements for data logic and data collection, and prepare for the generation and maintenance of system data files.
  Design stage
  4. Outline design specification
  This specification is the work product of the summary actual phase. It should explain the function allocation, module division, overall structure of the program, input and output, interface design, operation design, data structure design and error handling design, etc. Detailed design provides the basis.
  5. Detailed design specification
  focuses on describing how each module is realized, including the realization of algorithms, logic flow, etc.
  Development stage
  6. Monthly development progress report.
  This monthly report is a project progress report submitted by software personnel to the management department on a monthly basis. The report should include the comparison between the progress plan and the actual implementation, phase results, problems encountered and solutions, and Plans to wait next month.
  Test phase
  7, test plan
  In order to do a good job in integration testing and acceptance testing, an implementation plan must be developed for how to organize the testing. The plan should include the test content, schedule, conditions, personnel, test case selection principles, and allowable deviation range of test results.
  8. Test analysis report
  After the completion of the test work, an explanation of the execution of the test plan shall be submitted, the test results shall be analyzed, and the conclusion of the test shall be put forward.
  Final stage
  9. User operation manual
  This manual describes in detail the functions, performance and user interface of the software, so that users can get a specific understanding of how to use the software, and provide operators with knowledge about the various operating conditions of the software, especially the operating methods Specific details.
  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 input. In addition, it is necessary to evaluate the development work. Sum up experience and lessons.
  11. Software maintenance manual
  mainly includes software system description, program module description, operating environment, support software description, and maintenance process description, which is convenient for software maintenance.
  Maintenance stage
  12. Software problem report
  points out the registration of software problems, such as date, discoverer, status, module to which the problem belongs, etc., and
  provides preparation documents for software   modification.
  13. Software modification report    After the
  software product is put into operation, it is found that it needs to be corrected, changed, etc., and the existing problems, the consideration of the modification and the impact of the modification shall be described in detail and submitted for approval.

Guess you like

Origin blog.csdn.net/Toky_min/article/details/90448786