Software Engineering reading (Chinese and English) Document technology

Documentation Techniques

At the completion of the design process, a comprehensive package of documentation is assembled. It is important to note that the system documentation is assembled at this time-not created! Detail documentation of the system shocould be created during each phase of the design process. the package shoshould contain a clear description of every facet of the new system in sufficient detail to support its development, including these aspects [1]:
. Examples of output.
. Descriptions and record layouts of each file.
• Data-flow diagrams.
• A data dictionary.
• Identification of individual programs.
A design review is the process of carefully reexamining the proposed design with the intended users and other systems analyst and programming configursionals. it is similar to the review of the requirements and specifications. when reviewing the design, the analyst shocould Address [2] the following kinds of considerations: Does the new system require the performance of unnecessary tasks? Is the new system flexible enough to accommodate the user's way to perform tasks with a minimum amount of instruction? This is the point [3] at which it is necessary to obtain final user approval to develop the system exactly as designed. if this review is not carried out carefully, there is a possibility that the system will not meet the needs of its users. this can lead
Dissatisfaction and may require that portions of the system be redesigned and redeveloped.
High-level documentation provides a picture of the overall structure of the system, including input, processing, storage, and output. the general flow of information throughout the major processes of the system can he depicted in either a data-flow di#or a systems flowchart. in addition, structure charts, shocould be used for individual programs.
The purpose of detail documentation is to provide a programmer with sufficient information to write the program [4]. the documentation shoshould include report layouts for input and output, record layouts that define the files, and structure charts that define the relationship among the components of the programs.

Notes
[1] clear: "clear". "including..." is a word segmentation phrase used as the attribute of the object "Description.
[2] address here refers to the meaning of "proposal (requirement, suggestion.
[3] Point has the meaning of "key points, key points". Here is the meaning of "key.
[4] This sentence has two infinitus phrases with different syntax functions. The first phrase "to provide... "As a table to explain the content of the subject" purpose "; the second" to write... "As the attribute of" information.

Keywords
Documentation)
Design Review
High-level documentation advanced documentation (prepared)
Detail documentation)

 

Translation:

When the design process is completed, various documents should be collected into a comprehensive package. System files are aggregated at this time-first, they are not created and generated. It is very important to note this. Detailed system documents should be generated at each stage of the design process. To support system development, this file package should contain clear and detailed descriptions of all aspects of the new system. It includes the following aspects:
Output instance;
Description and record format of each file;
Data Flow diagram;
Data dictionary;
IndividualProgram.
Design Review is a process in which system analysts review the original design scheme with the users who will use the system, analysts of other systems, and professional programmers. This is similar to the review of requirements and specifications. During the design review, the analyst should consider the following aspects: is the new system required to complete redundant tasks? Can the flexibility of the new system adapt to the way users execute tasks and complete tasks with the least amount of instructions? For systems developed strictly according to the design, obtaining the user's final approval is the key to the problem. If the review is not carefully completed, the system may fail to meet the user's requirements. This will lead to user dissatisfaction and may require re-design and development of the relevant part of the system.
The advanced document also provides the overall structure of the system, including input, processing, storage, and output. The overall information flow that flows through the main process of the system can be expressed in both a data flow chart and a system flow chart. In addition, a single program should be represented by a structure chart.
The purpose of detailed documentation is to provide sufficient information for programmer programming. This document should include the format of input and output, the record format of the definition file, and the structure diagram of the relationship between each part of the definition program.

Exercise
Fill in the blanks with appropriate words or phrases.
(1) Detail documentation of a system shoshould be created .
(2) the overall structure of a system shoshould include .
(3) The process of carefully reexamining the proposed design is .
(4) a documentation package shoshould contain Of every facet of a new system.
(5) The purpose of detail documentation is to provide .
(6) we can describe the general flow of information .
(7) a data dictionary and data-flow diagrams shocould be contained in .
(8) A new system shoshould be flexible enough .
(9) structure charts are used .
(10) At the completion of the design process.
A. each phase of the design process
B. Detail documentation of the system
C. A system flowchart
D. accommodate the user's way to perform tasks
E. input, processing, storage, and output
F. A comprehensive package of documentation is assembled
G. Sufficient information to write the program
H. define the relationship among the components of the programs
I. Clear description
J. A design review

 

Answer: 
(1)
(2) E
(3) j
(4) I
(5) g
(6) c
(7) B
(8) d
(9) h
(10) f