Software Engineering-project development documentation (Detailed Design Instruction)

Detailed Design Instruction

1. Introduction

1.1 Writing Purpose

[Describe the purpose of writing this detailed design instruction and point out the intended readers.]

1.2 Background

A. [name of the 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. System Structure

[The system structure diagram is provided, including the software structure and hardware structure diagram. Use a series of charts to list the names and identifiers of each module in the system and their hierarchical relationships.]

3. Module 1 (identifier) Design Description

[Starting from this chapter, we will give the design considerations for each module at each layer one by one. The outline below is applicable to general situations. For a specific module, especially a low-level module or subroutine, many of its content is often the same as the content of the corresponding entries of the previous module to which it belongs, in this case, simply describe this.]

3.1 Module description

[A brief description of the basic module is provided, which mainly describes the purpose and significance of arranging the design of this module, and also describes the features of this module.]

3.2 features

[Describes the functions of the Basic module.]

3.3 Performance

[All performance requirements for this module are described.]

3.4 Input

[Provides features for each input item.]

3.5 output items

[Provides features for each output item.]

3.6 design method (algorithm)

[For software design, the algorithms selected in this program, the specific calculation formula and calculation steps should be described in detail.]

[For hardware design, the design principle, component selection, logical relationship of each component, and various protocols required for this module should be described in detail.]

3.7 process logic

[Use charts and necessary instructions to express the logic flow of this module.]

3.8 Interface

[Describes the logical connection mode between this module and other related modules, and describes the parameter transmission mode involved.]

3.9 Storage Allocation

[Describe the storage allocation of this module as needed.]

3.10 annotation Design

[Description of the program.]

3.11 restrictions

[Restrictions on the use of this module]

3.12 test plan

[Describe the plan to conduct a standalone test for this module, includes the technical requirements for testing, input data, expected results, schedules, personnel responsibilities, equipment conditions, drivers, and pile modules.]

3.13 unsolved problems

[The problems that the designer considers to be resolved before the system is completed have not been solved in the design of this module.]

4. Module 2 (identifier) Design Description

[This article describes the design considerations for the 3rd modules and N modules in a similar way.]