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

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　　　　　　　　　　　　　　　　详细文档（编制）

 

翻译：

　　设计过程完成时，要将各种文档汇集成一个全面性的文件包。系统文件只是在此时汇集而成－一不是创建生成，注意到这一点是非常重要的。系统的详细文档应该在设计过程的各个阶段中生成。为了支持系统的开发，该文件包应包含对新系统各方面的清晰而详尽的说明，它包括如下几个方面：
　　　　输出的实例；
　　　　每个文件的说明及记录格式；
　　　　数据流图；
　　　　数据字典；
　　　　各单个程序的标识。
　　设计评审是系统分析员与将要使用该系统的用户、其他系统的分析员以及专业编程人员一起重新仔细审查原设计方案的过程。这与需求和规格说明的复审类似。在评审设计的过程中，分析员应考虑以下几方面：新系统是否要求完成多余的任务？新系统的灵活性是否能适应用户执行任务的方式，以最少的指令完成任务？对于严格按设计来开发的系统，获得用户最后认可是问题的关键。如果这个评审工作没有认真仔细地完成，系统有可能达不到用户的要求。这将导致用户不满意，而且可能要求重新设计和开发系统的有关部分。
　　高级文档还提供了系统的总体结构图，包括输入、处理、存储及输出。流经系统的主要过程的总信息流既可用数据流图也可用系统流程图来表示。此外，单个程序应该用结构图表示。
　　详细文档编制的目的是为程序员编程提供充分的信息。此文档应包括输入输出的格式、定义文件的记录格式及定义程序各部分间关系的结构图。

EXERCISE
Fill in the blanks with appropriate words or phrases．
　　（1）Detail documentation of a system should be created during            ．
　　（2）The overall structure of a system should include             ．
　　（3）The process of carefully reexamining the proposed design is             ．
　　（4）A documentation package should contain a              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 by             ．
　　（7）A data dictionary and data-flow diagrams should be contained in             ．
　　（8）A new system should be flexible enough to             ．
　　（9）Structure charts are used to             ．
　　（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

 

答案： 
（1）a   
（2）e   
（3）j   
（4）i
（5）g   
（6）c   
（7）b   
（8）d
（9）h   
（10）f