Documentation required for software project development

In the process of project development, thirteen kinds of documents should be prepared according to the requirements. The requirements of document preparation are pertinence, accuracy, clarity, integrity, flexibility and traceability.
　　◇ Feasibility analysis report: 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 that can be selected in order to reasonably achieve the development goals, explain and demonstrate the selected justification for the implementation.

　　◇ Project development plan: Make a specific plan for the software project implementation plan, which should include the person in charge of each part of the work, the development progress, the budget for development funds, and the required hardware and software resources.

　 　◇ Software requirements specification (software specification specification): 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.

　　◇ Outline design specification: This specification is the work product of the actual stage of the summary. It should describe the function allocation, module division, the overall structure of the program, input and output, interface design, operation design, data structure design and error handling design, etc., for the detailed design. Provide the basis.

　　◇ Detailed design specification: focus on describing how each module is implemented, including the implementation algorithm, logic flow, etc.

　　◇ User operation manual: This manual describes the functions, performance and user interface of the software in detail, so that users can gain a specific understanding of how to use the software, and provide operators with relevant knowledge of various operating conditions of the software, especially the specific operation methods. detail.

　　◇ 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.

　　◇ 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.

　　◇ 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. Monthly plans and so on.

　　◇ 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. In addition, it is necessary to evaluate the development work. Summarize experiences and lessons learned.

　　◇ 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.

　　◇ Software problem report: Point out the registration status of software problems, such as date, discoverer, status, module to which the problem belongs, etc., and provide preparation documents for software modification.

　　◇ Software modification report: After the software product is put into operation, if problems such as modification and modification are found, the existing problems, consideration of modification and impact of modification shall be described in detail and submitted for approval.

Project Development Plan
1 Introduction
1.1 Purpose of writing: clarify the purpose of writing the feasibility study report, and propose the target audience

1.2 Project background: It should include
　　● the entrusting unit, the developing unit and the competent department of the project;
　　● the relationship between the software system and other systems. 1.3 Definitions :

List the original text of definitions and abbreviations used in 　　the 　　documents 　　● List the author, title, number, date of publication, publisher or source of these materials; 2 Project overview







2.1 Work content: briefly explain the main work of the project, and introduce the functions and performance of the developed software; if the feasibility study report is not prepared, a more detailed introduction should be given in this section;

2.2 Conditions and limitations: stated as The conditions that should be met to complete the project, the conditions that the development unit has already met, and the conditions that still need to be created. When necessary, the work undertaken by the user and the sub-contract, the completion period and other conditions and restrictions should also be explained.

2.3 Product

2.3.1 Program: List the name of the program to be delivered, the language used and the storage format.

2.3.2 Documentation: List the documentation that should be delivered.

2.4 Operating environment: It should include hardware environment and software environment.

2.5 Services: clarify the services that the development unit can provide to users. Such as personnel training, installation, warranty, maintenance and other operational support.

2.6 Acceptance Criteria

3 Implementation Plan
3.1 Task Decomposition: The division of tasks and the person in charge of each task.

3.2 Progress: Projects completed by stages, with charts to illustrate the start time and completion time.

3.3 Budget

3.4 Key Issues: Explain the key issues that may affect the project, such as equipment conditions, technical difficulties or other risk factors, and explain countermeasures.

4 Personnel organization and division of labor
5 Delivery period
6 Key points of the special plan
　　Such as test plan, quality assurance plan, configuration management plan, personnel training plan, system installation plan, etc.

Software Requirements Specification
1 Introduction
1.1 Purpose of writing: clarify the purpose of writing requirements specification and specify the audience.

1.2 Project background: It should include
　　● the entrusting unit, the happy unit and the competent department of the project;
　　● The relationship between the software system and other systems.

1.3 Definitions: List of definitions and acronyms for specific terms used in the document.

1.4 Reference materials: may include
　　● the project's approved schedule, contract or approval from the higher authority
　　● the documents cited, specifications, etc.
　　● list the author, title, number, publication date, publishing unit or source of these materials

2 Task Overview
2.1 Objectives

2.2 Operating Environment

2.3 Conditions and Limitations

3 Data Description
3.1 Expression Data

3.2 Dynamic Data: including input data and output data.

3.3 Database description: Give the name and type of database used.

3.4 Data dictionary

3.5 Data collection

4 Functional requirements
4.1 Functional division

4.2 Functional description

5 Performance requirements
5.1 Data accuracy

5.2 Time characteristics: such as response time, update processing time, data conversion and transmission time, running time, etc.

5.3 Adaptability: the adaptability that should be possessed when the operation mode, operating environment, interface with other software and development plan are changed.

6 Operational requirements
6.1 User interface: such as screen format, report format, menu format, input and output time, etc.

6.2 Hardware Interface

6.3 Software Interface

6.4 Troubleshooting

7 Other requirements
　　such as usability, security, maintainability, portability, etc.

Outline design specification
1 Introduction
1.1 Purpose of writing: clarify the purpose of writing the outline design specification, and specify the audience.

1.2 Project background: It should include
　　● the entrusting unit, development unit and competent department of the project
　　● the relationship between the software system and other systems.

1.3 Definitions: A willingness to list definitions and acronyms for specific terms used in this document.

1.4 Reference materials:
　　● List the author, title, serial number, date of publication, publisher or source of these materials
　　● Project's approved schedule, contract or approval from a higher authority; project development plan; requirements specification; test plan (Preliminary draft); User Manual
　　● Documents referenced materials, adopted standards or norms.

2 Task overview
2.1 Objectives

2.2 Requirement overview

2.3 Conditions and constraints

3 Overall design
3.2 Overall structure and external design of modules

3.3 Function allocation: Show the relationship between each function and program structure.

4 Interface Design
4.1 External interface: including user interface, software interface and hardware interface.

4.2 Internal interface: the interface between modules.

5 Data structure design
6 Logical structure design The unified cover format of
　　all documents is shown on the following page.

7 Physical structure design
8 Relationship between data structure and program
9 Operation design
9.1 Operation module combination

9.2 Operation control

9.3 Operation time

10 Error handling design
10.1 Error output information

10.2 Error handling countermeasures: such as setting backup, performance degradation, recovery and restart.

11 Security and confidentiality design
12 Maintenance design
　　Describe the facilities for facilitating maintenance work, such as maintenance modules.

Detailed design specification
1 Introduction
1.1 Writing purpose: clarify the purpose of writing detailed design specification, and specify the target audience.

1.2 Project background: It should include the source of the project and the competent authority.

1.3 Definitions: A willingness to list definitions and acronyms for specific terms used in this document.

1.4 Reference materials:
　　● List the author, title, serial number, publication date, publishing unit or data source of the relevant materials
　　● The project's approved schedule, contract or approval from a higher authority; project development plan; requirements specification; outline design Instructions; Test Plan (First Draft); User Manual
　　● Documents cited in the document, software development standards or specifications.

2 Overall Design
2.1 Requirement Overview

2.2 Software Structure: For example, the structure diagram of the software system is given.

3 Program Description
3.1 The following descriptions are given module by module:
　　● Function
　　● Performance
　　● Input items
　　● Output item

3.2 Algorithm: the algorithm selected by the module.

3.3 Program logic: describe the algorithm implemented by the module in detail, and can use: standard flow chart; PDL language; NS diagram; decision table and other diagrams describing the algorithm.

3.4 Interface
　　● Storage allocation
　　● Constraints

3.5 Test points: Give the main test requirements of the test module.

User Operation Manual
1 Introduction
1.1 Purpose of writing: clarify the purpose of writing the manual and specify the target audience.

1.2 Project background: explain the source of the project, the entrusting unit, the developing unit and the competent department.

1.3 Definitions: A willingness to list definitions and abbreviations for specialized terms used in the manual.

1.4 Reference materials:
　　● List the author, title, serial number, date of publication, publishing unit or data source of the relevant materials
　　● The project's approved schedule, contract or approval from a higher authority; project development plan; requirements specification; outline design Specifications; Detailed Design Specifications; Test Plans
　　● Other materials cited in the document, software engineering standards or software engineering specifications adopted.

2 Software Overview
2.1 Objectives

2.2 Functions

2.3 Performance

2.4 Data Accuracy: Including the accuracy of input, output and processing data.

2.5 Time characteristics: such as response time, processing time, data transmission time, etc.

2.6 Flexibility: the adaptability of the software when certain changes are required in the operation mode and operating environment.

3 Operating Environment
3.1 Hardware
　　● List the minimum hardware configuration required for the software system to run, such as computer model, main memory capacity
　　● External memory, media, recording format, device model and quantity
　　● Input and output devices
　　● Data transmission equipment and data conversion equipment models and quantity.

3.2 Support software
　　● Operating system name and version number
　　● Name and version number of language compilation system or assembly system ● Name and version number of database
　　management system
　　● Other necessary support software Forms, operating commands, feedback information and its meaning, test instances indicating the completion of the installation, and software tools required for the installation, etc. 4.2 Input: The requirements for input data or parameters are given. 　　● Data background: describe data sources, storage media, frequency of occurrence, limitations, and quality management. 　　● Data format: such as length, format reference, label, sequence, separator, vocabulary, omission and repetition, control. 　　● Input example. 4.3 Output: Give a description of each output data. 　　● Data background: describe the destination of the output data, the frequency of use, the storage medium, and quality management. 　　● Data format: specify the format of each output data, such as the specific form of the header, body and trailer. 　　● Example 4.4 Error and recovery: give error information and its meaning; actions the user should take, such as modification, recovery, and restart. 4.5 Query: Explain how to operate. 5 Operating Instructions



















5.1 Operation table: List each possible operation situation and explain its operation purpose.

5.2 Operation steps: each and every operation step shall be explained in sequence, which shall include:

5.3 Operation control

5.4 Operation information: operation purpose, operation purpose, operation requirements, start-up method, estimated operation time, operation command format and description, and other matters;

5.5 Input /Output file: Gives information about creating or updating files, such as: file name and number; recording medium; retained directory; file control: Describes the criteria for determining whether to keep or discard files, who to distribute files, and hardware priority and privacy control.

5.6 Startup or recovery process

6 Non-routine process
　　Provide necessary information and operation steps for emergency or non-routine operations, such as error handling operations, switching operations to the backup system, and operations and precautions for maintenance personnel.

7 List of operation commands
　　List the format, function and parameter description of all operation commands one by one in alphabetical order.

8 List of program files (or command files) and data files List
　　the file names, identifiers and descriptions one by one in alphabetical order of file names or in order of function and module classification.

9 Examples of user operations

Test plan
1 Introduction
1.1 Purpose of writing: clarify the purpose of writing the test plan and specify the audience.

1.2 Project background: explain the source of the project, the entrusting unit and the competent department.

1.3 Definitions: List the definitions of the technical terms used in the test plan and the original meaning of the abbreviations.

1.4 Reference materials: List the author, title, serial number, publication date, publishing unit or data source of the relevant materials, which may include: project plan, contract or approval; project development plan; requirements specification; outline design specification; detailed Design specification; user operation manual; other data cited in this test plan
, .

2 Task overview
2.1 Objectives

2.2 Operating environment

2.3 Requirement overview

2.4 Conditions and constraints

3 Plan
3.1 Test plan: Describe the test method and the principles for selecting test cases.

3.2 Test items: List the content, name, purpose and progress of each test in the assembly test and validation test.

3.3 Test preparation

3.4 Test organization and personnel: name of the test organization, person in charge and responsibilities.

4 Test item description
4.1 Explain the test items one by one in sequence

4.1.1 Test item name and test content

4.1.2 Test case

4.1.3 Input: input data and input command.

4.1.4 Output: Expected output data.

4.2 Steps and operations

4.3 Allowable deviation: The range of allowable deviation between the measured result and the expected result is given.

4.4 Progress

4.5 Condition: Give the special requirements for the resources of the item test, such as equipment, software, personnel, etc.

4.6 Test data: describe the data required for the item test.

5 Evaluation
5.1 Scope: Describe the scope of the problem and its limitations for each test performed.

5.2 Criteria: Describe the criteria for commenting on test results.

Test analysis report
1 Introduction
1.1 Purpose of writing: clarify the purpose of writing test analysis report and specify the audience.

1.2 Project background: explain the source of the project, the entrusting unit and the competent department.

1.3 Definitions: List the definitions of the technical terms and the original meanings of the abbreviations used in the test analysis report.

1.4 Reference materials: List the author, title, serial number, publication date, publishing unit or data source of the relevant materials, which may include: project plan, contract or approval; project development plan; requirements specification; outline design specification; detailed Design specification; user operation manual; test plan; other data cited in the test analysis report, software engineering standards or engineering specifications adopted.

2 Hospitality of the test plan
2.1 Organization and personnel: Give the name of the test organization, the person in charge and the list of participants in the test.

2.2 Test results: for each test item in order: the actual test result data; the deviation from the expected result data; the facts shown by the test; the problems found by the test.

3 Software Requirement Testing Conclusions The conclusions of each requirement testing are given
　　in order. Include: Demonstrated software capabilities; limitations (i.e., the circumstances and reasons why a requirement has not been adequately tested.

4 Evaluation
4.1 Software capabilities: Software capabilities demonstrated by testing.

4.2 Defects and limitations: Description of software defects and deficiencies revealed by testing , and the possible impact on the software operation.

4.3 Suggestion: put forward suggestions to make up for the above defects.

4.4 Test conclusion: explain whether it can pass.

Monthly report on development progress
1 Report time and development stage
2 Project progress
2.1 Main activities in this month

2.2 Comparison between actual progress and plan

3 Working hours used Timed
　　according to different levels of personnel.

Quoted from http://kitleer.blog.163.com/blog/static/9177857920101231323603