Summary design phase-Summary Design Manual

[Project name]

Summary Design Specification

[V1.0 (Version)]

 

Prepared ______________________
Reviewer ______________________
Approved ______________________

 

[Year, month, and day]

Summary Design Specification
1. Introduction
1.1 Writing Purpose
[Describe the purpose of preparing this summary Design Manual and point out the intended readers.]

1.2 Background
A. [name of the software system to be developed;]
B. [list the task initiators, developers, and users of this project.]

1.3 Definition
[Lists the definitions of specialized terms used in this document and the original phrases of the foreign acronyms.]

1.4 references
[List related references.]

2. Overall Design
2.1 Requirements
[Describe the main input/output items and functional performance requirements of the system. Including]
2.1.1 system functions

2.1.2 system performance
2.1.2.1 precision
2.1.2.2 time characteristics requirements
2.1.2.4 Reliability
2.1.2.5 flexibility

2.1.3 input and output requirements

2.1.4 data management capability requirements

2.1.5 fault handling requirements

2.1.6 other special requirements

2.2 Runtime Environment
[Briefly describe the operating environment of this system.]
2.2.1 Device
[List the hard devices required to run the software. Describes the new devices and their special functions.]

2.2.2 supporting software
[List the supported software, including the operating system to be used, compiled (or compiled) programs, and test support software.]

2.2.3 Interface
[Description of interfaces and data communication protocols between the system and other systems]

2.2.4 Control
[Describe how to control the operation and control signals of the system, and describe the sources of these control signals.]

2.3 Basic Design Concepts and handling processes
[Describe the basic design concepts and processes of the system, and try to use charts as much as possible.]

2.4 Structure
[Overall system structure diagram (including the software and hardware architecture diagram) is provided to describe the division of various modules of the system, and briefly describe the identifiers and functions of each system module, lists the control and controllable relationships between modules in different layers.]

2.5 relationship between functional requirements and system modules
[This section uses a matrix to describe the implementation of various functional requirements and the allocation relationship between modules.]
[System Module 1] [system module 2] [...] [System module M]
[Function requirement 1] √
[Function requirement 2] √
[Region]
[Function requirement n] √

2.6 Manual processing
[Manual processing that must be included in the work of the system.]

2.7 unsolved problems
[This section describes the issues that the designer considers to be resolved before the system is completed.]

3. Interface Design
3.1 User Interface
[Describe the commands that will be provided to users, their syntax structure, and corresponding response information.]
[Describe the definition of the hardware control panel for user operation.]

3.2 External Interface
[Description: The arrangement of all interfaces between the system and the outside world includes interfaces between the software and hardware and interfaces between the system and various supporting systems.]

3.3 Internal interface
[Describes the arrangement of interfaces between various system elements in the system.]
4. Operation Design
4.1 running module combination
[Describe the combination of different operation modules caused by the application of different external operation control to the system, and describe the supporting software for each internal module that has been used for each operation.]

4.2 Operation Control
[Describe the method and procedure of external operation control.]

4.3 running time
[It indicates that the combination of each running module will take up the time of various resources.]
5. System Data Structure Design
[Software design not involved]
5.1 Key Points of Logical Structure Design
[Names and identifiers of each data structure used by the software in the system, as well as the identifiers, definitions, lengths, and hierarchies or tables of each of the data items, records, volumes, and systems in the system .]

5.2 Key Points of Physical Structure Design
[Provides the storage requirements, access methods, access units, physical relationships, design considerations, and confidentiality requirements for each data item in each data structure used by the software in the system.]

5.3 relationship between data structures and programs
[Describe the correspondence between each data structure and each program accessing the data structure.]
[Procedure 1] [Procedure 2] [...] [Program m]
[Data Structure 1] √
[Data Structure 2] √
Bytes
[Data structure N] √

6. system error handling Design
6.1 error message
[The form, meaning, and solution of the system output information for each possible error or fault occurrence in the form of a list.]

6.2 remedy
[Description of possible workarounds after a fault occurs. Including:]
A. backup Technology [describe the backup technology to be used. If the raw system data is lost, the copy creation and startup technology will be enabled, for example, recording disk information to tape periodically is a backup technology for disk media.]
B. efficiency Reduction Technology [describe the backup technology to be used and use another less efficient system or method to obtain some of the required results, for example, the efficiency Reduction Technology of an automatic system can be manual operations and manual records of data.]
C. Recovery and Restart Technology [describes the recovery and restart technology to be used to restore the software from the fault point or re-run the software from the beginning.]

6.3 system maintenance Design
[Describe the arrangements made in the internal program design for the convenience of system maintenance, including the inspection points and dedicated modules for system inspection and maintenance in the program.]

# Software Engineering