Software detailed design template

Hello everyone , I meet you again , I'm your friend, Quan Jun .

The product name Product name	Secret class Confidentiality level
product version Product version	Total 8 pages common 8 page
V1.01

XXX Software details Design Instructions

Prepared by Draw up		Date date	2010-11-23
Reviewed by Reviewer		Date date
Approved by approval		Date date

Revision Record A revision history

Date date	Revision Version The revision edition	Sec No. modify chapter	Change Description Modify description	Author author

Catalog

1 introduction . 5

1.1 Purpose of writing . 5

1.2 background . 5

1.3 Reference material . 5

1.4 Definitions and descriptions of terms . 5

2 Design Overview . 5

2.1 Tasks and objectives . 5

2.1.1 Requirements overview . 5

2.1.2 Overview of operating environment . 6

2.1.3 Conditions and limitations . 6

2.1.4 Detailed design methods and tools . 6

3 Detailed system requirements analysis . 6

3.1 Detailed requirements analysis . 6

3.2 Detailed system operation environment and constraints analysis interface requirements analysis . 6

4 Confirmation of overall plan . 7

4.1 Confirmation of the overall structure of the system . 7

4.2 System detailed interface division . 7

4.2.1 Detailed interface division of application system and support system . 7

4.2.2 Detailed interface division inside the system . 7

5 Detailed design of the system . 7

5.1 System structure design and subsystem division . 7

5.2 Detailed design of system function module . 8

5.3 Detailed design of system interface . 8

5.3.1 External interface design . 8

5.3.2 Internal interface design . 9

5.3.3 User interface design . 9

6、 Database system design . 9

6.1 The design requirements . 9

6.2 Information model design . 9

6.3 Database design . 9

6.3.1 Design basis . 9

6.3.2 Database selection . 9

6.3.3 Database types and characteristics . 9

6.3.4 Logical structure of database . 9

6.3.5 Physical structure design . 10

6.3.6 database security . 10

6.3.7 The data dictionary . 10

7 Information coding design . 10

7.3 Code structure design . 10

7.4 Coding . 10

1 introduction

1.1 Purpose of writing

Explain the main purpose of preparing the detailed design scheme .

The purpose of the specification is to explain each program in each level of a software system （ Each module or subroutine ） And database system design considerations , Provide basis for programmer coding .

If a software system is relatively simple , There are few levels , This document may not be written separately , And the non repeated parts in the outline design specification .

The key point of the scheme is the description of the execution process of the module and the detailed design of the database system .

1.2 background

It should include the following aspects ：

A. Name of software system to be developed ;

B. The basic concept of the system , Such as the type of the system 、 Subordination, etc ;

C. Name of development project team .

1.3 Reference material

List the documents or materials cited in the detailed design report , The author of the material 、 title 、 Information such as publishing unit and publishing date , If necessary, explain how to get these materials .

1.4 Definitions and descriptions of terms

List the technical terms used in this document that may cause confusion 、 The original text of definitions and abbreviations .

2 Design Overview

2.1 Tasks and objectives

Explain the tasks of the detailed design and the objectives to be achieved by the detailed design .

2.1.1 Requirements overview

Brief description of the developed software , Including major business needs 、 Input 、 Output 、 The main function 、 Performance etc. , In particular, it is necessary to describe the system performance requirements .

2.1.2 Overview of operating environment

The hardware on which the system depends , Including the operating system 、 Database system 、 middleware 、 Software interface 、 Description of possible software environments such as performance monitoring and analysis , And configuration requirements .

2.1.3 Conditions and limitations

Describe in detail the constraints and restrictions of the internal and external conditions the system is subject to . Including business and technical conditions and restrictions as well as progress 、 Management and other restrictions .

2.1.4 Detailed design methods and tools

Briefly describe the methods and tools used in the detailed design . Such as HIPO Figure method 、IDEF（I2DEF） Method 、E－R chart , Data flow chart 、 Business flow chart 、 Selected CASE Tools etc. , Try to use standard specifications and auxiliary tools .

3 Detailed system requirements analysis

It mainly analyzes the system level requirements . First, we should further confirm the enterprise needs proposed by the demand analysis , And a more detailed analysis of the demand changes caused by changes in the situation .

3.1 Detailed requirements analysis

Include ：

• Detailed functional requirements analysis
• Detailed performance requirements analysis
• Detailed resource demand analysis
• Detailed analysis of system operation environment and limiting conditions

3.2 Detailed system operation environment and constraints analysis interface requirements analysis

Include ：

• System interface requirements analysis
• Existing hard 、 Software resource interface requirements analysis
• Introduce hard 、 Software resource interface requirements analysis

4 Confirmation of overall plan

Focus on the confirmation of the overall structure of the system and the division of the interface .

4.1 Confirmation of the overall structure of the system

For system composition 、 Confirm the logical structure and level , For application systems 、 Confirm the support system and their respective functions , Refine the integrated design and system workflow , Pay special attention to the structural changes of the system itself and other systems of the company caused by the introduction of software . Include ：

Ÿ System composition 、 Logical structure and level confirmation

Ÿ Application system structure confirmation

Ÿ Confirmation of support system structure

Ÿ System integration confirmation

Ÿ System workflow confirmation

4.2 System detailed interface division

4.2.1 Detailed interface division of application system and support system

The interface between the application system and the supporting system includes the service scope and access mode of the main server of the system and other servers , Network and database support the application system , Management and access mode of global data .

4.2.2 Detailed interface division inside the system

The interface between various functions of the system includes coverage , System modules and methods involved in function call between modules , Global data format , System performance requirements, etc .

5 Detailed design of the system

5.1 System structure design and subsystem division

Confirm the composition and logical structure of the system before design .

Divide system function modules or subsystems （ If necessary , Especially for large software systems ）.

5.2 Detailed design of system function module

According to the structural design method , Based on the decomposition of system functions layer by layer , Design each functional module or subsystem of the system . This is one of the main parts of the detailed design .

Describe the overall structure of the system with a hierarchy diagram 、 Function decomposition and the mutual calling relationship and information interaction between various modules , use IPO Figure or other methods to describe the functions completed by each module . It is suggested that HIPO Figure for functional decomposition and module description , Higher requirements suggest IDEF0 Methods to design the functional model .

Design in detail the functions completed by each constituent module of the application system and the relationship between them , use IPO Or the structure diagram describes the composition structure of each module 、 Algorithm 、 Interface relationship between modules , And demand 、 Cross reference relationship between functions and modules .

The description of each module can refer to the following format ：

Module number ：

Module name ：

Input ：

Handle ：

Algorithm description ：

Output ：

The processing and algorithm description are mainly completed by pseudo code or specific programming language .

For higher requirements of detailed design, it is suggested to use IDEF0 Figure design each function module .

If the software needs secondary development （ Including function extension 、 Functional transformation 、 User interface transformation ）, Then the corresponding design work should set up sub topics to complete .

5.3 Detailed design of system interface

The system interface describes various interfaces of the application system software . Other interfaces of the whole system （ Such as system hardware interface 、 Communication interface ） Explain in the corresponding section .

5.3.1 External interface design

Design the external interface of the system according to the division of the system interface , All external interfaces to the system （ Including functions and data interfaces ） Design .

5.3.2 Internal interface design

Design the calling relationship and data interface between the functional modules in the system .

5.3.3 User interface design

Specify the content of human-machine interface 、 Interface style 、 Call mode, etc , Including the so-called form design 、 Report design and printout design required by users . There may be more content in this part .

6、 Database system design

This database design can be made into a separate volume , Especially for large database application systems , That is, there is a separate 《 Database design specification 》.

6.1 The design requirements

6.2 Information model design

Determine the type of system information （ Entity or view ）, Determine the attributes of the system information entity 、 The relationship between keywords and entities , Describe the database and structure design in detail , Data element and attribute definitions , Data relation pattern , Data constraints and limitations .

6.3 Database design

6.3.1 Design basis

Explain the frequency and flow of data access , Maximum data storage , Data growth , Storage time and other database design basis .

6.3.2 Database types and characteristics

Describe the types of databases applied in the system 、 Their characteristics 、 Quantity and how to realize interconnection , How to transfer data .

6.3.3 Logical structure of database

Explain the methodology and tools used in the transformation of database conceptual schema to logical schema , Complete the transformation from database conceptual schema to logical schema . List in detail each data item in the data structure used 、 Identification of records and documents 、 Definition 、 Length and the relationship between them . This section is the main part of database design .

6.3.4 Physical structure design

List the storage requirements of each data item in the data structure used 、 Access method 、 Access units and physical relations of access . Create a system programmer view , Include ：

Ÿ The arrangement of data in memory , Including the index area 、 Buffer design ;

Ÿ The external storage equipment used and the organization of external storage space , Including index area 、 Organization and division of data blocks ;

Ÿ How to access data .

6.3.5 database security

Explain how data is shared , How to ensure the security and confidentiality of data .

6.3.6 The data dictionary

Write a detailed data dictionary . For various projects involved in database design , Such as data items 、 Record 、 system 、 File mode 、 Generally, a data dictionary should be established for sub patterns , To describe their identifiers 、 Synonyms and related information .

7 Information coding design

7.3 Code structure design

Confirm the overall scheme of information classification and coding , Design the classification code structure .

7.4 Coding

Compile the information code according to the code structure

Publisher ： Full stack programmer stack length , Reprint please indicate the source ：https://javaforall.cn/126249.html Link to the original text ：https://javaforall.cn