系統設計報告編寫規范東大阿爾派軟件公司-資料下載頁

【導讀】體系結構、組成成分、數據組織、模塊、內外部接口。1)建立軟件產品和軟件項目目標系統的總體結構。對于大規模軟件系統，應分為若干。子系統，在本報告中只說明總體設計，然后為每個子系統編寫《系統設計報告》；4)涉及使用數據庫的設計需編寫數據庫設計。適用于軟件開發設計階段的《系統設計報告》的編寫。本程序采用NQ402100《質量手冊》中的術語和縮略語及其定義。1）整個規范由2節構成，模板單獨一節。2）正文樣式采用“規范正文”。3）標題編號采用每節獨立編號。系統設計報告的編寫可依據具體情況選用摸板的格式或編寫指南的格式。2）刪除第一節。3）在修改完內容后，更新目錄域和相關的頁數域。以下部分為系統設計報告的模板與編寫指南。

　　

【正文】 User Procedures 用戶規程 System navigation 系統導航 描述那些使用戶能充分使用系統的規則； Routine 例程 ? 描述在正常工作環境下，系統預期的使用方法； ? 使用流程圖來描述例程，流程圖要帶有輔助描述，描述那些使用每個功能的用戶的類型。 Exception 例外處理 描述系統在異常情況下所使用的處理方式，如網絡失效時的數據恢復。 Installation 安裝 描述系統的安裝過程。 System architecture 系統結構 Design principles 設計原則 描述系統設計所采用的策略，如用戶界面的形式，所使用的標準產品等。 Design rationale 設計原理 系統設計報告編寫指南 沈陽東大阿爾派軟件股份有限公司 ? 描述進行設計的依據，如數據庫結構等； ? 模塊調用原理：是內部還是外部，是修改還是重建或重用。 Software ponents and interfaces 軟件組件和接口 ? 描述系統中的主要組件，包括它們之間傳遞的包和數據流； ? 數據流圖和功能分解圖； ? 描述所引用的外部模塊。 Capacity requirements 系統資源需求 估計系統容量等需求的臨界值，如內存、磁盤空間和、傳輸速率等。 System structure 系統結構 描述系統的各模塊是如何連接在一起工作的。 Data 數據 Definitions 定義 對系統中包含的所有數據項的描述。 Database design 數據庫設計 ? 對邏輯數據庫 /文件設計的描述； ? 對物理數據庫 /文件設計的描述； ? 數據校驗規則。 Calculations 算法 ? 定義系統所采用的計算或算法； ? 確定實現這些 算法的流程。 Data management procedures 數據管理程序 描述對系統數據的管理流程，如存檔等。 Module specifications 模塊說明 ? 詳細描述每個模塊的邏輯、功能或每個模塊的所有狀態、與其他模塊的關聯、狀態的變遷、存在的條件及采取的動作； ? 使用簡潔、標準的語言； ? 說明每個模塊的輸入和輸出。 Physical environment 物理環境 描述建立和運行系統所需要的物理環境。 Appendices 附錄 系統設計報告編寫指南 沈陽東大阿爾派軟件股份有限公司 ? 數據流圖 ? 數據模型 系統設計報告編寫指南 沈陽東大阿爾派軟件股份有限公司 系統設計報告檢查表項目名稱： 項目編號：序號 內容 Yes No 不適用1 整個系統組織很清晰，并包括一個良好的體系結構概述和v e r i f i c a t i o n2 對模塊進行明確定義，包括模塊的功能說明和與其它模塊的接口說明3 包含需求分析報告中列出來的所有功能4 主要的數據結構被調用函數隱藏起來了5 描述數據庫的組織結構和內容6 描述并驗證所有關鍵的算法7 定義了用戶接口的關鍵方面8 包括一致的錯誤處理策略9 將錯誤信息清晰、簡潔地反映在用戶界面上10 體系結構的設計可以適應可能發生的變化11 作為實現系統的程序員，你對這個體系結構感到滿意12 描述了處理用戶輸入的策略13 清晰地闡述了系統的主要目標14 所有主要的數據結構都有描述過并通過v e r i f i c a t i o n15 描述并驗證所有主要的對象16 用戶接口都被模塊化以使其內部的變化不對程序的其它部分產生影響17 對內存的使用事先作了估計并對內存管理策略進行了描述和v e r i f i c a t i o n18 在體系結構中對每個模塊的空間和速度作了預算19 描述了字符串的處理策略，在其中包括了對字符 字符串存儲的估計20 描述并驗證了對I / O 處理的策略21 描述了系統的健壯程度22 包括必須購買的工具以及進行B U I L D 的決定23 存在某一個部分不在體系結構描述之內24 體系結構在概念上是一個整體25 設計獨立于機器和實現語言26 所有重要決定都具有相應的動機27 誰是這個特性的用戶28 用戶如何使用這項特性？用戶如何了解這項特性？方式直觀明顯嗎？29 用戶使用這項特性的動機是什么？30 用戶對用戶接口的看法如何？U I 的邏輯流程是什么？用戶期望的結果是什么？31 如果用戶在使用這項特性時沒有成功地達到目標會發生什么？他（她）能做什32 實現這個特性（或完成一個任務）之后，用戶返回到合適的位置繼續工作了嗎？33 特性或過程的出口明顯嗎？如果用戶錯誤地激活了該項特性后能容易地退出和返34 這個特性可以U n d o 嗎？35 還有其它的方法可以實現這個特性嗎？如果有,是什么？36 用戶要使用這個特性時需要了解哪些東西？是不是你不能奢望用戶要掌握的？37 有多少是用戶必須去做但與關鍵任務（也可稱為第一號工作）無關的任務？38 兩個類似過程間的對話框看起來是一致的嗎？39 是否同一個對話框用于多個任務? 對話框的名稱和選項按鈕的名稱隨著任務而變40 用戶愿意把這個特性與其它特性或過程結合起來嗎？41 這個特性或過程 與本產品或相似產品中的其它特性或過程保持一致性？42 有其它的開發隊伍在進行相關的特性或過程的開發？兩支開發隊伍的工作協調一43 要對該特性或過程進行修改以適應國外市場44 對于不同語言環境，該特性需要做相應的變化45 在將來不同的版本以不同的方式來實現這個特性總分:注：1 1 1項，Ye s ( + 6分)，No ( 6分)；其他各項，Ye s ( + 1分)，No ( 1分）；不適用 0分。審核人/ 日期： 批準人/ 日期：