National standard for Software design documentation-Overview Design Manual

Source: http://www.5ixue.com/e/tool/gfen?id=422570

Overview Design Manual

1 Introduction

1.1 Purpose of writing

1.2 Background

1.3 Definitions

1.4 References

2 overall design

2.1 Requirement Requirements

2.2 Operating Environment

2.3 Basic design concepts and process flow

2.4 Structure

2.5 The relationship between the function and the program

2.6 Manual Process

2.7 Questions not yet to be asked

3 Interface Design

3.1 User Interface

3.2 External interface

3.3 Internal Interface

4 Running the design

4.1 Running the module combination

4.2 Operation Control

4.3 Run time

5 System data Structure design

5.1 Key points of logical structure design

5.2 Physical Structure Design essentials

5.3 The relationship between data structure and program

6.1 Error message

6.2 Remedial measures

6.3 System Maintenance Design

1 Introduction 1.1 Purpose of writing

Explain the purpose of writing this summary design manual, pointing out the intended audience. 1.2 Background

Description

A. The name of the software system to be developed;

B. List the task-seekers, developers, users, and the compute stations (centers) that will run the software for this project. 1.3 Definitions

List the definitions of the terminology used in this document and the original phrase of the foreign language first letter group. 1.4 References

List the relevant reference files, such as:

A. The approved plan or contract of the project, and the approval of the superior authority;

B. Other published documents belonging to this item;

C. Documents and information referenced throughout the present document, including the software development standards to be used. The headings, file numbers, publication dates and publication units of these documents are listed, indicating the source of the information available. 2 overall design 2.1 Requirements

Explain the main input and output items of the system, the functional performance requirements of the processing, detailed description can be found in Appendix C. 2.2 Operating Environment

Provide a brief description of the operating environment of the system (including the hardware environment and the supporting environment), see Appendix C for details. 2.3 Basic design concepts and process flow

Explain the basic design concept and process flow of the system, use the form of chart as far as possible. 2.4 Structure

The system elements (each layer module, subroutine, utility program, etc.) are explained in the form of the list and block diagram, and the identifiers and functions of each system element are explained, and the control and control relationship between the elements are given in a hierarchical way. 2.5 The relationship between the function and the program

This article uses a matrix diagram as follows to illustrate the functional requirements of the implementation of the same block program distribution relationship:

	Procedure 1	Procedure 2	......	Program N
Functional Requirements 1	√
Functional Requirements 2		√
......
Functional Requirements N		√		√

2.6 Manual Process

Describe the manual process (if any) that must be included in the work of the software system. 2.7 Questions not yet to be asked

Describes the various issues that the designer believes must be addressed before the system is completed while the design process has not yet been resolved. 3 Interface Design 3.1 user Interface

Describes the commands that will be provided to the user and their grammatical structure, as well as the software's response information. 3.2 External Interface

The arrangement of all the interfaces between the system and the outside world includes the interface between software and hardware, the interface between the system and the supporting software. 3.3 Internal Interface

Describe the arrangement of the interfaces between the various system elements within the system. 4 Running the design 4.1 Running the module combination

Describes the different combinations of operating modules that are generated when different external operating controls are applied to the system, explaining the internal modules and supporting software that each runs through. 4.2 Operation Control

This paper describes the methods and procedures of each kind of external operation control. 4.3 run time

Describes the time that each combination of running modules will occupy various resources. 5 system data Structure design 5.1 Logical Structure Design Essentials

Give the name and identifier of each data structure used in the system, and the identification, definition, length, and the hierarchical or tabular interrelationship between each of them. 5.2 Physical Structure Design essentials

The storage requirements, access methods, access units, physical relationships (indexes, devices, storage areas), design considerations and confidentiality conditions of each data item used in the system are given. 5.3 The relationship between data structure and program

Describes the various data structures and the form of accessing these data structures:

6 system error Handling 6.1 error message

The form, implication and processing method of the system output information are stated in a list of the possible error or fault situations in Lang. 6.2 Remedial measures

Describes possible workarounds that may be taken after a failure, including:

A. Back-up technical description of the backup technology to be used when the original system data in case of loss of the enabled copy of the establishment and launch of the technology, such as the periodic recording of disk information to tape is a backup technology for disk media;

B. The technology for reducing the efficiency of the proposed backup technology, the use of another less efficient system or method to obtain some parts of the desired results, such as an automatic system of the efficiency of the technology can be manual operation and data manual record;

C. Recovery and restart Technology Note the method that will be used by the recovery restart technology to enable the software to resume execution from the point of failure or to make the software rerun from the beginning. 6.3 System Maintenance Design

Describes the arrangements for the internal design of the program for the convenience of system maintenance, including the detection points and special modules specially arranged for the inspection and maintenance of the system in the program. The correspondence between the various programs can be used in the form of matrix diagram as follows;