software engineering document

Why writing is improtant ?

1、To provide a reliable basis not only for users but for programmers

The document is equivalent to the law, if there any errors after programming had done, could check it account for whom


Building a system is very easy, but the later maintenance work is a problem that good programming team need to consider.


what is the purpose? 


1、FSR (feasibility study report)

feasibility

Showing that the software development project aims at feasibility in technology, economy and social conditions; Reviewing in order to achieve development goals and may reasonably choose the various solutions and so on. At the start of a project, you need to complete the feasibility study report, the research is able to complete this project, explain the reason.


2、Project Development Plan

Main purpose is make development system for the main planning and integration, play a guide role in the development process, and  provide simple instructions to the consumer.

It's for the project leader to check the project development plan, the project development plan, and how long can complete, is the most direct evidence check schedule.


3、software requirement specification

  • Communication

    The users' requirement;The  designer's basic springboard of software development;

    System maintenance personnel find and add new functional requirements

  • Confirmation of supporting for the target system.

    The software development goals to be achieved is not should be decided by the system     test phase of the artificial factor, and should be established according to the     specification can be test standard.

  • Process of Control system evolution.

    After completion of the requirements analysis, if the user additional demand, then the     specification will be used to determine whether additional demand for the new     requirements. If it is, the developer must according to the new requirements in terms     of demand analysis, expansion of requirements specifications, to software design.

4、Procedural Design Specification 

Providing developers for instruction to develop and complete the system in shortest possible time more efficiently 

 

5\ Database design specification

Providing FOr database design, structure situation of project, used in the project design for developers, as well as for the subsequent database maintenace work, also for a improtant stuff about the future version upgrade.


6、test plan specification

  • Testing software, detailed record the testing process, to evaluate the software's appetite, provides the basis of the BUG of software designers. 

  • test plan specification is drawn up in the process of project development, providing various test scheme for testing, can be more convenient to find bugs in the project.


7、Test analysis report

In order to find more errors, for various test by test plan, explain in detail the results.


8、Project Development summary Report 

  • State The development of the actual results.

  • declare the evaluation of the all aspects of whole  development work.

  • illustrate The objective of the workflow

  • Conditions of engineering development

  • Result && experience


9、Operation manual and user manual

  • The purpose can let the user familiar with this system.


10、DPMR Development process month report

To provide the reliable basis for project leader to develop at their own pace, and efficient complete software development, and provide the basis for the development of the project summary report