軟體工程閱讀(中英文對照)之文檔技術

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