Detailed design manual
Li Yu (reprinted from the national computer standard and file template)
1 Introduction 1.1 Writing Objective Description Writes 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 Lists the definition of the specifically used in this document and the original phrase of the foreign letter group word. 1.4 References List the relevant references, such as: a. The approved planning 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 The structure of the program system uses a series of charts to list each program in this program system (including each module and subroutine) name, identifier, and hierarchical relationship between them. 3 Program 1 (Identifier) Design Description From this chapter, the design consideration of each program in each level is 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 gives a brief description of the program, mainly explaining the meaning of the purpose of the design of this program, and also explains the characteristics of this program (if the resident memory is still very stationed? Is it a numerous person? Is it still not heavy? Is there any coverage? Is it sequential or concurrently processed .... 3.2 Function Description This program should have the function of the IPO map (i.e., input one processing one output map). 3.3 Performance Description All Performance requirements of the program, including accuracy, flexibility, and time characteristics. 3.4 Logs gives the characteristics of each entry, including name, identification, and data, and efficient range of data values, and input. Quantities and frequencies, input media, source and security conditions of data, and more. 3. 5 Output gives the characteristics of each output, including name, identification, data, and valid range of data values, output form, quantity, and frequency, output media, indicating output graphics, and symbols, Safety and confidentiality conditions, etc. 3.6 Algorithm details the algorithm selected by this procedure, specific calculation formula and calculation steps. 3.7 Process Logic A graphic (for example, a flow chart, determination table, etc.) to represent the logical flow of this program. 3.8 Interface Drawing Form Description The last layer module of this program and the next layer module, subroutine, subroutine, description parameter assignment and call mode, and the data structure associated with this program ( Database, data volumes). 3.9 Storage Distribution Describes the storage allocation of this program as needed. 3.10 Comment Design Description Prepare annotations scheduled in this program, such as: a. Add the annotation of the header of the module; b. Annotation added at each branch point; a notes added to the function, scope, default conditions, etc. of each variable; D. Comments added to the logic used, and the like. 3.11 Restricting conditions illustrate the restrictions received in this procedure.
