Thirteen documents in software engineering

Thirteen kinds of documents in software engineering ( http://ss.zsu.edu.cn/UploadFile/2007430184649725.doc ), A good reference , If you don't know how to start when writing documents , Or this document can give you some inspiration .

In the process of project development , Thirteen kinds of documents should be written as required , The documentation requirements are targeted 、 Accuracy 、 Clarity 、 integrity 、 flexibility 、 traceability .

 ◇ Feasibility analysis report ： It shows that the implementation of the software development project is technically 、 Economic and social feasibility , Comment on various possible implementation schemes that can be selected in order to reasonably achieve the development objectives , Explain and demonstrate the reasons for the selected implementation scheme .

◇ Project development plan ： Make a specific plan for the software project implementation plan , It should include the person in charge of each part of the work 、 Progress of development 、 Budget of development funds 、 Required hardware and software resources, etc .

◇ Software requirements specification （ Software specifications ）： Functions of the developed software 、 performance 、 Make a detailed description of the user interface and operating environment . It is written under the condition that both users and developers have reached a common understanding and agreement on software requirements , It is also the basis for the implementation of development work . The instructions shall give various requirements for data logic and data acquisition , Prepare for generating and maintaining system data files .

◇ Outline design specification ： The manual is a summary of the actual stage of work , It should state the allocation of functions 、 Module partition 、 The overall structure of the program 、 I / O and interface design 、 Operation design 、 Data structure design and error handling design , Provide the basis for detailed design .

◇ Detailed design specification ： The first mock exam is to describe how each module is implemented. , Including the implementation algorithm 、 Logic flow, etc .

◇ User manual ： This manual describes the functions of the software in detail 、 Performance and user interface , Enable users to get a specific understanding of how to use the software , Provide operators with relevant knowledge of various operation conditions of the software , In particular, the specific details of the operation method .

◇ test plan ： In order to do well in integration test and acceptance test , An implementation plan needs to be developed for how to organize the test . The plan should include the contents of the test 、 speed of progress 、 Conditions 、 personnel 、 Selection principle of test cases 、 Allowable deviation range of test results, etc .

◇ Test analysis report ： After the test work is completed , A description of the implementation of the test plan shall be submitted , Analyze the test results , And put forward the conclusion of the test .

◇ Monthly development progress report ： The monthly report is the project progress report submitted by the software personnel to the management department on a monthly basis , The report shall include the comparison between the progress plan and the actual implementation 、 Stage results 、 Problems encountered, solutions and plans for next month .

◇ Project development summary report ： After the software project development is completed , It should be compared with the project implementation plan , Summarize the actual implementation , Such as progress 、 results 、 Resource utilization 、 Cost and manpower invested , Besides , The development work needs to be evaluated , Sum up experience and lessons .

◇ Software maintenance manual ： It mainly includes software system description 、 Program module description 、 Operating environment 、 Description of supporting software 、 Description of maintenance process , Convenient for software maintenance .

◇ Software problem report ： Indicate the registration of software problems , Such as date 、 Discover people 、 state 、 Module to which the problem belongs , Provide preparation documents for software modification .
　　◇ Software modification report ： After the software product is put into operation , It is found that it needs to be corrected 、 Change and other issues , The existing problems should be 、 Make a detailed description of the consideration of the modification and the impact of the modification , Submit for approval .

Link to the original text ：https://blog.csdn.net/ourteam/article/details/1967289