Detailed design manual
1 Introduction
1.1 Writing
Description Writing the purpose of this detailed design manual, pointing out the expected readers.
1.2 background
Description:
a. The name of the software system is developed;
b. The task of this project is proposed, developers, users, and calculation centers for running the program system.
1.3 definition
List the definition of specifically used in this document and the original phrase of the foreign letter group word.
1.4 Reference
List the relevant references, such as:
a. The approved planned task book or contract of the project, the approval of the superior authority;
b. Other published files belonging to this item;
C. The documents referenced by each of this document include the software development standards to be used. List the title, file number, publishing date, and publishing unit of these files, indicating that the source of these files can be obtained.
2 architecture system structure
A series of charts list the names, identifiers and hierarchical relationships between each program (including each module and subroutine) in this program system.
3 Program 1 (identifier) design description
From this chapter, design considerations of each program in each level are given one by one. The outline given below is for normal conditions. For a specific module, especially a relatively low module or subroutine, many of its items are often the same as the contents of the corresponding entry of the previous module it belong, in this case, as long as this is simply A little bit.
3.1 Program Description
A brief description of the procedure is given, mainly indicates the meaning of the purpose of the design of this procedure, and it will also explain the characteristics of this program (if the resident memory is still very stationed? Is it a numerous person? • Is there any coverage? Is it sequential or concurrent processing, etc.).
3.2 function
Note The function of the program should be in the form of an IPO map (i.e., input one processing one output map).
3.3 performance
Note All performance requirements for the program, including requirements for accuracy, flexibility, and time characteristics.
3.4 Log
Given the feature of each entry, including the name, identification, data type and format, valid range of data values, and input. Quantities and frequencies, input media, source and security conditions of data, and more.
3.5 output item
Given the characteristics of each output, including the name, identification, data, the valid range of the data value, the output, the number, and frequency, the output medium, the description of the output graphics, and symbols, security confidential conditions and many more.
3.6 algorithm
Detailed explanation of the algorithms selected in this procedure, specific calculation formulas and calculation steps.
3.7 Process Logic
The logic flow of this program is represented by the necessary description by a chart (such as a flow chart, determination table, etc.).
3.8 interface
In the form of the figure, the previous layer module, which is part of this program is part of this program, subroutine, subroutine, description parameter assignment, and call mode, indicating data structure directly related to this program (database, data text) volume).
3.9 Storage Assignment
The storage allocation of this program will be described as needed.
3.10 Comment Design
Description Prepare annotations arranged in this procedure, such as:
a. Add a comment in the module header;
b. Add the comments at each branch point;
C. Comments added to the functions, scope, default conditions, etc. of each variable;
d. Comments added to the logic used, and the like.
3.11 restriction conditions
Describe the restrictions received in this program.
3.12 Test Plan
Note Program for monomer testing of this program, including technical requirements, input data, expected results, progress arrangements, person responsibilities, equipment conditions drivers, and pile modules, etc.
3.13 I have not solved problems
Note The designer considers problems that should be resolved before the software is completed in the design of this program.
4 Program 2 (Identifier) Design Description Use Similar F. 3 way, explain the design considerations of the second program and even the Nth program.
......
