What does the Software engineering documentation standard include?

It programmer development Essentials-all kinds of resources download list, history of the most IT resources, personal collection summary.

During the development of the project, 13 documents should be written as required, and the documentation requirements are targeted, accurate, clear, complete, flexible, and traceable.
◇ Feasibility Analysis Report: Explain the feasibility of the implementation of the Software development Project on the technical, economic and social factors, and comment on the reasons of the selected implementation plan in order to reasonably meet the various possible implementation options for the development target.

◇ Project Development Plan: to develop a specific plan for the implementation of the software project, should include the responsible personnel of each part of the work, the progress of development, the budget of development funds, the required hardware and software resources.

◇ Software Requirement Specification (software specification): The function, performance, user interface and operating environment of the software developed are described in detail. It is written under the condition that both the user and the developer have a common understanding and agreement on the software requirements, and it is the basis of the implementation of the development work. The specification should give the data logic and the requirements of the collection, in order to generate and maintain the system data files ready.

◇ Summary Design Specification: This manual is a summary of the actual stage of the work results, it should explain the function allocation, module division, the overall structure of the program, input and output and interface design, operation design, data structure design and error processing design, to provide the basis for detailed design.

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

◇ User manual: This manual describes the function, performance and user interface of the software, which gives the user a detailed understanding of how to use the software, and provides the operator with the knowledge of the various operating conditions of the software, especially the details of the operation method.

◇ Test Plan: In order to do the integration test and acceptance test, the implementation plan should be developed for how to organize and test. The plan should include the content of the test, progress, conditions, personnel, the selection of test cases, the allowable deviation range of the test results, etc.

◇ Test Analysis Report: After the completion of the test work, the test plan should be submitted a description of the implementation of the test results are analyzed, and put forward the test of the concluding comments.

◇ Development Progress Monthly: The monthly report of the software personnel to the management of the project progress reports, the report should include the progress plan and actual implementation of the comparison, stage results, problems encountered and solutions, and the next month's plan.

◇ 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, in addition, also need to evaluate the development work, summed up the experience and lessons.

◇ Software Maintenance Manual: mainly includes software system description, program module description, operating environment, support software Description, maintenance process description, easy to maintain the software.

◇ software Problem Report: Indicate the registration of software problems, such as date, discovery person, status, problem belongs to the module, to provide preparation for software modification documents.

◇ Software Modification Report: After the SOFTWARE PRODUCT is put into operation, it is found that it needs to be amended, changed and so on, the existing problems, modification considerations and the influence of the modification should be described in detail and submitted for approval.

Project Development Plan
1 Introduction
1.1 Purpose: To clarify the purpose of preparing the feasibility study report and to propose the reader object

1.2 Project background: should include
The entrusted units, development units and competent departments of the project;
The relationship between the software system and other systems.

1.3 Definition: List the definitions and abbreviations of the special terms used in the document

1.4 References: may include:
Approval of the project's approved plan of assignment, contract or superior authority
Materials, specifications, etc. referenced in the document
List the author, title, number, publication date, publication unit or source of the information;

2 Project Overview
2.1 Work Content: Brief description of the main work of the project, introduce the function of the software developed, performance, etc., if not to write a feasibility study report, you should give a more detailed introduction in this section;

2.2 Articles and limitations: clarify the conditions to be fulfilled in order to complete the project, the conditions that the development unit already has, and the conditions that are still to be created. The work, completion period and other conditions and limitations of the user and sub-contract shall also be described if necessary.

2.3 Products

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

2.3.2 Documentation: Lists the documents that should be delivered.

2.4 Operating environment: should include hardware environment, software environment.

2.5 Service: Clarify the service that the development Organization can provide to the user. 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 responsible for each task.

3.2 Progress: Projects completed by stages, with charts explaining the start time, finish time.

3.3 Budget

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

4 Personnel organization and division of Labor
5 Delivery term
6 highlights of the thematic plan
such as test plan, quality assurance plan, configuration management plan, personnel training plan, system installation plan, etc.

Software Requirement Specification
1 Introduction
1.1 Purpose: To clarify the purpose of writing the requirements statement, indicating the reader object.

1.2 Project background: should include
The entrusted unit, Happy Unit and competent department of the project;
The relationship between the software system and other systems.

1.3 Definition: A wish to list the definitions and abbreviations of the specialized terms used in the document.

1.4 References: may include
Approval of the project's approved plan of assignment, contract or superior authority
Materials, specifications, etc. referenced in the document
List the author, title, number, publication date, publication unit, or source of the information

2 Overview of tasks
2.1 Goals

2.2 Operating Environment

2.3 Items and Limitations

3 Data Description
3.1 Stance Data

3.2 Dynamic Data: Includes input data and output data.

3.3 Database Description: Gives the name and type of the database used.

3.4 Data Dictionary

3.5 Data acquisition

4 Functional Requirements
4.1 Functional Divisions

4.2 Function 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: In the way of operation, operating environment, interface with other software and development plan change, should have adaptability.

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 Fault Handling

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

Overview Design Manual
1 Introduction
1.1 Writing Purpose: To clarify the purpose of writing a summary design specification, indicating the reader object.

1.2 Project background: should include
Entrusted units, development units and competent departments of the project
The relationship between the software system and other systems.

1.3 Definition: The willingness to list the definitions and abbreviations of the terminology used in this document.

1.4 References:
List the author, title, number, publication date, publication unit, or source of the information
Approval of project tasks, contracts or higher authorities, project development plan, requirements Specification, test plan (first draft), User manual
The materials referenced in the document, the standards or specifications adopted.

2 Overview of tasks
2.1 Goals

2.2 Requirements Overview

2.3 Items and Limitations

3 Overall Design
3.2 Overall structure and module exterior design

3.3 Function Assignment: Indicates the relationship between function and program structure.

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

4.2 Internal interface: the interface between the modules.

5 Data structure Design
6 Logical Structure Design
The unified cover page format for all documents is shown in the following pages.

7 Physical Structure Design
8 The relationship between data structure and program
9 Running the design
9.1 Combination of running modules

9.2 Operation Control

9.3 Run time

10 Error Handling Design
10.1 Error Output information

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

11 Secure and confidential design
12 Maintenance Design
Description for the convenience of maintenance work facilities, such as maintenance modules.

Detailed design Instructions
1 Introduction
1.1 Purpose: To clarify the purpose of writing a detailed design specification, indicating the reader object.

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

1.3 Definition: The willingness to list the definitions and abbreviations of the terminology used in this document.

1.4 References:
List the author, title, number, publication date, publication unit, or source of the information
Approval of project tasks, contracts or higher authorities, project development plan, requirement specification, summary design specification, test plan (first draft), User manual
The document refers to the data, software development standards or specifications.

2 overall design
2.1 Requirements Overview

2.2 Software structure: Give the structure diagram of software system.

3 Program Description
3.1 The following instructions are given on a per-module basis:
function
Performance
Enter Project
Output Project

3.2 algorithm: The algorithm chosen by the module.

3.3 Program Logic: Detailed description of the module implementation of the algorithm, can be used: standard flow chart; PDL language; n-s diagram; decision table and other descriptive algorithms.

3.4 Interface
Storage allocation
Restriction conditions

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

User Operating Manual
1 Introduction
1.1 Purpose: To clarify the purpose of the preparation of the manual, indicating the reader object.

1.2 Project background: Explain the source of the project, the entrusted Unit, the Development Unit and the competent department.

1.3 Definition: Lists the definitions of the terminology used in the manuals and the willingness to abbreviate the words.

1.4 References:
List the author, title, number, publication date, publication unit, or source of the information
Approval of project tasks, contracts or higher authorities, project development plan, requirement specification, summary design specification, detailed design specification, test plan
Other materials referenced in the documentation, software engineering standards used, or engineering software specifications.

2 Software Overview
2.1 Goals

2.2 Features

2.3 Performance

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

2.5 Time characteristics: such as response time, processing time, data transmission time and so on.

2.6 Flexibility: The adaptability of the software in the mode of operation and the need for certain changes in the operating environment.

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

3.2 Support Software
Operating system name and version number
Name and version number of the language compiling system or assembler system
Name and version number of the database management system
Other necessary support software

4 Instructions for use
4.1 Installation and initialization: gives the program's storage form, Operation command, feedback information and its implication, the test example indicating the installation completed, and the software tools required for installation.

4.2 Input: Gives the requirements for input data or parameters.
Data background: Explains data sources, storage media, frequency of occurrence, limitations, and quality management.
Data formats: such as length, Format datum, label, order, delimiter, glossary, ellipsis and repetition, control.
Enter an example.

4.3 output: Gives a description of each output data.
Data background: Explain the whereabouts of the output data, frequency of use, storage media and quality management.
Data format: Details the format of each output data, such as the specific form of the header, body, and tail.
For example

4.4 Error and Recovery: give the error message and its meaning, the action that the user should take, such as modify, restore, restart.

4.5 query: Describes how to operate.

5 Operating Instructions
5.1 Run Table: lists each of the possible operating conditions, indicating the purpose of its operation.

5.2 Running steps: Each and every step is described sequentially and should include:

5.3 Operation Control

5.4 Operation Information: Operation purpose, operating purpose, operation requirements, starting method, expected run time, Operation command format and description, and other matters;

5.5 Input/Output files: Give information about creating or updating a file, such as the name and number of the file, the recording media, the remaining directory, the control of the document, the guidelines for determining the retention or discarding of files, the distribution of the objects, the priority of the hardware, and the secrecy control.

5.6 Startup or recovery process

6 Non-routine processes
Provide necessary information and procedures for emergency ring non-routine operation, such as error handling operation, switch operation to back-up system and maintenance personnel instructions and precautions.

7 List of OPERATIONAL commands
Lists the format, function, and parameter descriptions of all operations commands in alphabetical order.

8 Program Files (or command files) and data files list
List file names, identifiers, and descriptions in alphabetical order by file name, or by function and module sort order.

9 User Action Examples

Test Plan
1 Introduction
1.1 Purpose: To clarify the purpose of writing a test plan and to indicate the reader object.

1.2 Project background: Explain the source of the project, the entrusted unit and the competent department.

1.3 Definition: Lists the definitions and acronyms of the specific terms used in the test plan.

1.4 References: Lists the author, title, number, date of publication, publication unit or source of the information, which may include: Project plan, contract or approval, project development plan, requirement specification, summary design specification, detailed design specification, user manual, other information referenced in this test plan, Using
Standards or specifications for software development.

2 Overview of tasks
2.1 Goals

2.2 Operating Environment

2.3 Requirements Overview

2.4 Items and limitations

3 Planning
3.1 Test scenario: Describes the test method and the principle of selecting a test case.

3.2 Test Project: Lists 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: the name of the test organization, responsible person and responsibility.

4 Test Project description
4.1 In order to explain the test project one by one

4.1.1 Test project name and test content

4.1.2 Test Cases

4.1.3 Input: Input data and input commands.

4.1.4 Output: Expected output data.

4.2 Steps and Operation

4.3 Allowable deviation: Gives the range of allowable deviations between the measured and expected results.

4.4 Progress

4.5 article: To give out the test of the special requirements of resources, such as equipment, software, personnel and so on.

4.6 Test Data: The information required for the test of the description.

5 reviews
5.1 Scope: Indicates the scope of the problem and its limitations in the various tests completed.

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

Test Analysis Report
1 Introduction
1.1 Purpose: To clarify the purpose of writing the test analysis report and to indicate the reader object.

1.2 Project background: Explain the source of the project, the entrusted unit and the competent department.

1.3 Definition: Lists the definitions of the terminology used in the test analysis report and the original meaning of the abbreviations.

1.4 References: Lists the author, title, number, date of publication, publishing unit or source of information, which may include: Project task book, Contract or approval, project development plan, requirement specification, summary design specification, detailed design specification, user operation manual, test plan , other materials referenced in the test analysis report, software engineering standards used, or engineering specifications.

2 Test Plan Hospitality situation
2.1 Institutions and personnel: give the name of the test organization, the responsible person and the list of participating testers.

2.2 Test Result: Each test item is given in order: The measured result data, deviation from the expected result data, the fact that the test indicates, the problem that the test finds.

3 Software Requirement Test conclusion
The conclusion of each requirement test is given sequentially. Includes: Proven software capabilities, limitations (i.e., the circumstances and reasons for which the requirements have not been adequately tested.

4 reviews
4.1 Software capabilities: the software capabilities that have been tested.

4.2 Defects and limitations: Describes the software defects and deficiencies exposed by the test, and the impact it may have on the software operation.

4.3 Recommendation: To make up for the above deficiencies.

4.4 Test Conclusion: The explanation can pass.

Development progress Report
1 Reporting time and development phase
2 Project Progress
2.1 Major events during the month

2.2 Actual progress vs. Plan comparison

3 hours used
At different levels of the staff to time separately.