软件工程阅读之文档技术(中英文对照)

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 should be created during each phase of the design process．The package should 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 professionals．It is similar to the review of the requirements and specifications．When reviewing the design，the analyst should 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 to
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 diagram or a systems flowchart．In addition，structure charts，should 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 should 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：此处是指“条理清晰的”；“including...”是分词短语，作宾语“description”的定语。
[2]address在这里为“提（要求，建议）”之意。
[3]point有“要点，要害”之意，此处是“关键”之意。
[4]此句有两个不定式短语，其语法功能不同，第一个“to provide...”作表语说明主语“purpose”的内容；第二个“to write...”作“information”的定语。

KEYWORDS
　　documentation　　　　　　　　　　　　　　　　　　　　文档（编制）
　　design review　　　　　　　　　　　　　　　　　　　　设计评审
　　high-level documentation　　　　　　　　　　　　　　高级文档（编制）
　　detail documentation　　　　　　　　　　　　　　　　详细文档（编制）