Standardized documentation for Software development

During the development of the project, 13 documents should be written as required, and the documentation requirements are targeted, accurate, clear, complete, flexible, and traceable.

◇ Feasibility Analysis Report: Explain the feasibility of the implementation of the Software development Project on the technical, economic and social factors, and comment on the reasons of the selected implementation plan in order to reasonably meet the various possible implementation options for the development target.

◇ Project Development Plan: to develop a specific plan for the implementation of the software project, should include the responsible personnel of each part of the work, the progress of development, the budget of development funds, the required hardware and software resources.

◇ Software Requirement Specification (software specification): The function, performance, user interface and operating environment of the software developed are described in detail. It is written under the condition that both the user and the developer have a common understanding and agreement on the software requirements, and it is the basis of the implementation of the development work. The specification should give the data logic and the requirements of the collection, in order to generate and maintain the system data files ready.

◇ Summary Design Specification: This manual is a summary of the actual stage of the work results, it should explain the function allocation, module division, the overall structure of the program, input and output and interface design, operation design, data structure design and error processing design, to provide the basis for detailed design.

◇ Detailed Design Specification: emphatically describes how each module is implemented, including the implementation of algorithms, logic flow and so on.

◇ User manual: This manual describes the function, performance and user interface of the software, which gives the user a detailed understanding of how to use the software, and provides the operator with the knowledge of the various operating conditions of the software, especially the details of the operation method.

◇ Test Plan: In order to do the integration test and acceptance test, the implementation plan should be developed for how to organize and test. The plan should include the content of the test, progress, conditions, personnel, the selection of test cases, the allowable deviation range of the test results, etc.

◇ Test Analysis Report: After the completion of the test work, the test plan should be submitted a description of the implementation of the test results are analyzed, and put forward the test of the concluding comments.

◇ Development Progress Monthly: The monthly report of the software personnel to the management of the project progress reports, the report should include the progress plan and actual implementation of the comparison, stage results, problems encountered and solutions, and the next month's plan.

◇ Project Development Summary Report: After the completion of software project development, should be compared with the project implementation plan, summarize the actual implementation of the situation, such as progress, results, resource utilization, cost and input of manpower, in addition, also need to evaluate the development work, summed up the experience and lessons.

◇ Software Maintenance Manual: mainly includes software system description, program module description, operating environment, support software Description, maintenance process description, easy to maintain the software.

◇ software Problem Report: Indicate the registration of software problems, such as date, discovery person, status, problem belongs to the module, to provide preparation for software modification documents.

◇ Software Modification Report: After the SOFTWARE PRODUCT is put into operation, it is found that it needs to be amended, changed and so on, the existing problems, modification considerations and the influence of the modification should be described in detail and submitted for approval.

Standardized documentation for Software development