Reprinted from: http://zz563143188.iteye.com/blog/1835305
Students of software engineering know that software engineering is a subject with high technical content and extremely complex design. In order to control the quality and specification of software products, a large number of documents must be used to constrain the progress and status of software engineering. The vastness of software engineering is bound to be confusing for people who lack work and project experience and don't know where to start. In order to allow everyone to quickly adapt to the standard software development process, today I will briefly describe the documents required in the development for you, and I will explain the introduction in accordance with the national software quality standards.
In the process of project development, thirteen kinds of documents should be prepared as required, and the requirements for document preparation should be pertinence, accuracy, clarity, integrity, flexibility and traceability.
Project document management software I recommend everyone to use (Telelogic doors V8.0), this software can manage a lot of project documents well.
Telelogic doors V8.0 download:
http://pan.baidu.com/share/link?shareid=372668&uk=4076915866
Telelogic doors V8.0 usage introduction:
http://zz563143188.iteye.com/blog/1830393
Detailed explanation of project development process and architecture: http://zz563143188.iteye.com/blog/1825168
Next will be the introduction of thirteen kinds of documents (please download the attachment for the document template)
Explain the feasibility of the realization of the software development project in terms of technical, economic and social factors, comment on
various possible implementation schemes to reasonably achieve the development goals, explain and demonstrate the
The rationale for the chosen implementation .
2. ◇ Project development plan:
Make a specific plan for the software project implementation plan, which should include the responsible personnel for each part of the work, the
development progress, the development budget, and the required hardware and software resources.
3. ◇ Software requirements specification (software specification specification, standard documents required for system testing):
make a detailed description of the functions, performance, user interface and operating environment of the developed software. It is
written under the condition that both users and developers have a common understanding and agreement on software requirements, and it is also the basis for
implementing development work. This specification shall give the requirements for data logic and data acquisition, and
prepare for the generation and maintenance of system data files.
4. ◇ Outline design specification:
This specification is the work product of the actual phase of the outline. It should describe function allocation, module division,
overall program structure, input and output, interface design, operation design, data structure design and error handling design,
etc. Detailed design provides the basis.
5. ◇ Detailed design specification:
focus on describing how each module is implemented, including the implementation algorithm, logic flow, etc. 6.◇ User Operation Manual:
This manual describes the function, performance and user interface of the software in detail, so that the user can
get a specific understanding of how to use the software, and provide the operator with the relevant knowledge of various operating conditions of the software, especially
the specific details of the operation method.
7. ◇ Test plan:
In order to do integration testing and acceptance testing, it is necessary to formulate an implementation plan for how to organize testing. The plan should include
the test content, progress, conditions, personnel, the selection principle of test cases, and the allowable deviation range of test results.
8. ◇ Test analysis report:
After the test work is completed, a description of the implementation of the test plan should be submitted, the test results should be
analyzed , and the conclusion of the test should be put forward. 9.◇ Monthly report on development progress: The 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, stage results, problems encountered and solutions, and Looking forward to next month . 10. ◇ Project development summary report: After the software project development is completed, it should be compared with the project implementation plan to summarize the actual implementation, such as progress, results, resource utilization, cost and input manpower. Evaluate and summarize experiences and lessons learned. 11. ◇ Software Maintenance Manual: It mainly includes software system description, program module description, operating environment, description of supporting software, and description of maintenance process, which is convenient for software maintenance. 12.
◇ 软件问题报告：
指出软件问题的登记情况，如日期、发现人、状态、问题所属模块等，为
软件修改提供准备文档。
13. ◇ 软件修改报告：
软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存在
的问题、修改的考虑以及修改的影响作出详细的描述，提交审批。