1 Introduction
1.1 Objective
Describes the purpose of writing this document, the main content and the reader.
1.2 Requirements overview
Describe the functionality and performance that you want to implement.
1.3 Nouns and abbreviations
Lists the definitions and abbreviations of the specialized terms used in the document.
1.4 Resources
May include:
A. Approval of the project's approved plan of work, contract or superior authority;
B. Project development Plan;
C. Requirements Specification;
D. The materials, standards, and specifications referenced in the document. Lists the author, title, number, publication date, publication unit, or source of the information.
Reference list
Serial number Name AuthorNumber Release dateView locations or Channels Publishing unit (please fill in this column if not published by the company)
1.
2.
3.
4.
2 Software overview
Introduce the application of software, development and operation of the background, design constraints and so on.
2.1 System Overview
Describe the main functions of the software, as well as the location and role of this module and subsystem in the system.
2.2 Operating Environment
Describes the software and hardware environment in which the program runs.
2.3 Design constraints
Lists assumptions and constraints for the development of the software, such as the language used, development tools, development platforms, middleware, databases, external interfaces, and code and test specifications followed.
3 Overall structural design
3.1 Software architecture
In the form of Block diagram, the system elements (each layer module, subroutine, utility program, etc.) are divided, and the identifiers and functions of each system element are explained, and the control and control relationship between each element is given in a hierarchical way.
3.2 Design ideas
The basic design idea and concept of this system are expounded.
3.3 Unresolved issues
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.
4 Module design
In this list, the name, function, interface, release form and other information of each module are described.
4.1 Module 1
The function, interface and internal realization of each function module are described in detail.
4.1.1 Function description
The internal structure of the functional area can be illustrated graphically, with detailed data interface flows to other functional modules.
4.1.2 Interface description
messages, functions, etc.
4.1.3 Data structure Description
The data structure used in this functional area.
4.1.4 Class and object descriptions
Use class diagrams and object graph descriptions.
4.1.5 Processing flow
Draw the implementation process of the module functions.
4.1.6 Compiling and linking instructions
Requirements for compiling and linking the modules, such as static links, dynamic links, generate obj, lib, DLL, bin, hex, etc.
4.2 Module 2
......
5 Run the design
Describes the system's tasks, threads, and process settings in a list, including types, functions, priorities, management methods, and so on.
6 Functional implementation Process
The implementation process of each function is described in detail using use case diagrams, Sequence diagrams, and SDL graphs.
7 System Performance Analysis
Lists system key performance indicators and analyzes functional points that affect system performance.
8 Database and data structure design
8.1 Database and data Sheets
Describes the database system used, and the database and data table design.
8.2 Data structure Design
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.
8.3 Data storage Design
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.
9 Timer design
The list describes the type, purpose, range, default value, start, stop, scan, timeout processing, and so on for all timers.
10 External interface Design
The arrangement of all the interfaces between the system and the outside world includes the interface between the software and the hardware, the interface between the supporting software and the interface between the network management.
10.1 User interface Design
See the UI Design Guide.
10.2 Hardware interface
Describes the types of hardware interfaces that need to be accessed, how they are controlled, such as interrupts, registers, and so on.
10.3 Software interface
Describes the interface to other modules and subsystems.
11 Compatibility design
Lists the compatibility issues that may exist between the previous and the previous versions, as well as other modules, systems, subsystems, and countermeasures.
12 System Maintenance Design
12.1 Install and upgrade
Describe the software installation and use considerations.
Describes how software is upgraded, as well as compatibility and data migration considerations in the upgrade.
12.2 System Configuration
Lists the contents of the system's various configuration items.
12.3 Daily Maintenance
If there is a need for routine maintenance, give specific implementation methods.
13 System Test Design
The implementation method is described in detail from static testing of code to dynamic testing at runtime.
14 Safe and reliable design
14.1 System security
1. System security control and physical protection measures
2. User identification mechanism
3. User access and scope for the system
14.2 Data security
In the design of the database, how to design the database security and confidentiality by differentiating the different visitors, different types of access and different data objects, and how to treat them separately are considered, for example:
1. Data user identification
2. Control strategy and implementation method during access
3. Data encryption method
14.3 Reliability Design
14.3.1 Failure mode and Impact analysis (FMEA)
The list analyzes various possible failure modes, as well as corresponding countermeasures.
14.3.2 Error avoidance and fault tolerance design
The error avoidance and fault tolerant design measures are enumerated to reduce the probability of system failure.
14.3.3 Redundant design
such as the use of system redundancy, data redundancy and other measures.
14.3.4 Fault detection and recovery mechanisms
Can use watchdog, daemon, exception handling mechanism to detect system failure, and local or global restart mechanism to restore system operation.
For data recovery, you can recover from redundant or backup data.
15 Log and error handling
15.1 Log logging mechanism
A checklist of how each of the possible logs, such as running logs, operation logs, and fault logs, is logged and the content is recorded.
15.2 Error message and output mechanism
The form, meaning and processing method of the system output information are illustrated by a list of each possible error or fault condition.
Source: Http://blog.csdn.net/lezhiyong
Copyright NOTICE: This article for Bo Master original article, without Bo Master permission not reproduced.
Software overview Design Instructions-Templates
