Documentation for each stage of the soft work

Documentation for each stage of the soft work

One, from the software life cycle view

From the whole life cycle of software, it is divided into six stages: feasibility study and planning stage, requirement analysis stage, design stage, realization stage, testing stage, operation and maintenance stage.

Software engineering is just a software development process, and the life cycle includes software from the birth, until the end of the entire process, including the software development process, so the software life cycle includes the software project.

After the software engineering and the development is completed, the later operation and maintenance phases constitute the whole life cycle of the softwares.

Ii. the target user of each stage of the soft work document

Each stage of the software documentation, each document has its role, in writing this document must have a corresponding target user, is to whom to see, who need to use this document.

Iii. description of the documentation for each stage of the soft work

Each document in each phase of the software engineering has its specific role, which is what the document is intended to do, and each document is written with a very clear purpose, which is what it will be when the document is finalized.

Feasibility Study report: Demonstrate the feasibility of the software project in the technical, economic and social factors.

Project Development Plan: A specific plan for the implementation of the software project.

Software Requirement Specification: The function, performance, user interface and operating environment of the target software are described in detail.

Data Requirements Specification: Give the data logical description and the requirements of the collection, in order to generate and maintain the system's data files ready.

Summary Design Specification: This specification is the result of the summary design work phase.

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

User manual: Describes the software's functionality, performance, and user interface in detail, giving users an idea of how to use the software.

Operation Manual: To provide operators with knowledge of various operating conditions of the software, especially the operation method details.

Maintenance modification Suggestion: After the SOFTWARE product puts into operation, may have the amendment, the change and so on the question, should the existence question, the revision consideration as well as the modification influence estimate to do the detailed description, writes the maintenance revise proposal, submits the approval.

Development Progress Monthly: The monthly report is the progress of the project submitted by the software personnel to the management Department on a monthly basis. The report should include a comparison of progress plans with actual implementation, phase results, problems encountered and solutions, and plans for next month.

Test plan: For assembly testing and validation testing, plan for organization testing needs to be developed.

Test Analysis Report: After the test work is completed, a description of the performance of the test plan should be submitted. The test results were analyzed and the concluding observations of the test were put forward.

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.