Several templates for outline design

Reference: http://www.cnblogs.com/xumenger/articles/4401609.html

Reprinted from: http://blog.163.com/zhaowenchao_vip/blog/static/17151514420114994944208/

template One (software Development document template)

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 System error Handling design
6.1 Error message
6.2 Remedial measures
6.3 System Maintenance Design

template Two (ISO9001 standard document template)

Chapter 1th Introduction
1.1 Purpose of writing
1.2 Terminology
1.3 References
2nd Chapter System Overview
2.1 System Description
2.2 System Tasks
2.2.1 System target
2.2.2 Operating Environment
2.2.3 Relationship with other systems
2.3 Requirement Requirements
2.3.1 Functional Requirements
2.3.2 Performance requirements
2.3.3 Data requirements
2.3.4 Other
3rd Chapter General Design
3.1 System Physical Structure
3.1.1 System flowchart
3.1.2 Equipment List
3.2 Software structure diagram
3.2.1 Module Structure diagram
3.2.2 Module List
4th Chapter Module Function description
4.1 Module 1 (identifier) function
4.2 Module 2 (identifier) function
5th Chapter Interface Design
5.1 User Interface
5.2 Hardware Interface
5.3 Software Interface
5.4 Communication interface
The 6th chapter data structure Design
6.1 Data structure 1 (identifier)
6.1.1 Structure Properties
6.1.2 Logical Structure
6.1.3 Physical Structure
6.1.4 Data Elements
6.2 Data Structure 2 (identifier)
7th Chapter Operation Design
7.1 Running 1
7.1.1 Run module combination run name
7.1.2 Operation Control operation
7.1.3 Run time
7.2 Running 2
8th Chapter System Security
8.1 System security
8.2 Data Security
8.3 Backup and Recovery
8.4 Error Handling
8.5 Prevention and cure measures of computer virus
9th functional requirements, data structure and modules
9.1 Functional Requirements and module relationship
9.2 Data structure and module relationship

template Three (summary 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.

template Four (outline writing specification)

specification for the preparation of "Summary design Instructions"
Software summary design is also called Software system (program system) design, this document should explain the software system as a program system design of the overall consideration, including the basic process of the system, software system structure, module division, function allocation, data structure, interface, operation, error handling and system maintenance, etc. design, Provides the basis for detailed design.
1 Introduction
1.1 Purpose of writing
Describe the purpose of writing this design manual and indicate the intended audience.
1.2 Background
A. Describe the name of the software system to be developed.
B. List the authors, developers, and users who developed the software system.
1.3 Baseline
Describe the design baseline of the system design.
1.4 Range
Describe the scope of design content covered by this design manual.
1.5 Definitions
Lists the special terms used in this design manual and the original phrases of the foreign letter group.
1.6 References
A. Other published documents belonging to the project;
B. The documents and materials referenced in this design manual, including the software development standards used.
Lists the title, number, publication date, publication unit, and lookup source for these documents.
2 overall design
2.1 Overview
2.1.1 Requirements Regulations
The main input, processing, output functions and performance requirements of the system are described.
2.2.2 Operating Environment
The hardware environment and the supporting environment of this system are described.
2.2 Design
2.2.1 Design Concept
The conception, key techniques, main algorithm and key data structure of the system design are described.
2.2.2 System Flow
A. Use flowchart to show the main control process and process flow of the system;
B. Use the flowchart to show the main data path of the system and explain the main stages of the process.
2.2.3 Structure Design
A. System elements
Determine the elements of the system and its functions, with a list of the system elements (each layer of modules, subroutines, utilities, etc.) division, according to the level of their identifiers and functions.
B. System hierarchy
The control and controlled relationship between the elements of each system are given by the block diagram in a hierarchical way.
Relationship between functional requirements and procedures of 2.2.4
With the function requirement and the program matrix Chart form, shows the realization of each function and the distribution relation between each system element.
3 System data Structure design
3.1 Data structures
Lists the main data structures used by the system, including names, identifiers, and data items.
3.2 The relationship between the data structure and the system elements
The relationship between the data structure and the system elements accessing these data structures is shown in the form of a matrix diagram between the data structure and the system elements.
4 Interface Design
4.1 User Interface
Explain the command, grammatical structure and system reply information provided by the system to the user.
4.2 External interface
The interface between the software of the system and the hardware and supporting software is described.
4.3 Internal interface
Describe the interface between the relevant modules within the system.
5 Running the design
5.1 System Initialization
Describes the system initialization process.
5.2 Running the module combination
It shows the combination of internal modules and supporting software for each external operation of the system.
5.3 Operation Control
Describe the control methods, methods and operation steps of each external operation.
5.4 Run time
Describes when each of the running module combinations is expected to occupy various resources.
5.5 Operational Safety
Describes the control of the safe operation of the system.
6 Information structure design (when relevant requirements or software specifications are defined)
According to the logical structure and physical structure, the design points of information about the software are given.
6.1 Logical Structure Design
6.1.1 Graphic Design
6.1.2 Chinese (including a single Chinese character, phrase, phrase). ) Design
6.2 Physical Structure Design
6.2.1 Graphic Design
6.2.2 Chinese (including a single Chinese character, phrase, phrase). ) Design
6.3 The relationship between information structure and procedure
The relationship between the information structure and the system elements accessing these information structures is illustrated by using the matrix chart form between the information structure and the system elements.
7 Error handling and maintenance
7.1 Error message
The information forms and meanings of various possible errors or faults in this system are listed in the list.
7.2 Remedial measures
Describes possible workarounds that may be taken after a system failure, including:
A. Backup technology-enable the creation and launch of replicas when the system's original data is lost;
B. Efficiency-reduction techniques-use another less efficient method to obtain certain parts of the desired result, such as manual manipulation and manual recording of data;
C. Recovery and re-start technology--the method of recovering the system from the point of failure or the system starting from a new start.
7.3 System Maintenance
It describes the special modules for the detection and maintenance of the system and the system inspection and maintenance.
8 issues yet to be resolved
Describes the problems that should be resolved before the system is completed in this design.

Additional Instructions:
* This specification according to the national standard GB/T 8566-1995, the reference national standard GB 8567-88 and set up;
* When writing this document, you are required to have all the entries specified in this specification. If an item has been described elsewhere or has no content to fill, you should declare or fill out "no content to fill in" and, where possible, explain the reason.
* When preparing the document, the typographic format is prepared according to the "document typesetting and printing format Convention".

Several templates for outline design