某信息技術(shù)公司系統(tǒng)設(shè)計報告編寫規(guī)范(編輯修改稿)
2025-05-09 13:14 本頁面
【文章內(nèi)容簡介】 接口，并列出這些外部接口說明材料名。 外部存貯結(jié)構(gòu)設(shè)計說明本系統(tǒng)存貯于磁盤等持久性存貯介質(zhì)，而且不是由數(shù)據(jù)庫管理系統(tǒng)進行管理的數(shù)據(jù)的組織結(jié)構(gòu)，包括數(shù)據(jù)名稱、用途、每個數(shù)據(jù)項的標識名、類型和含義，組織結(jié)構(gòu)、訪問方法和存儲要求。2 / 184. 故障處理說明說明本系統(tǒng)所采用的基本錯誤處理方法和原則，例如：統(tǒng)一采用 C++ trycatch 錯誤方法，所有錯誤最終必須以界面形式向用戶說明。用一覽表方式說明各類可能的錯誤或故障出現(xiàn)時系統(tǒng)的處理方法和補救措施。5. 數(shù)據(jù)庫設(shè)計 數(shù)據(jù)字典設(shè)計對數(shù)據(jù)庫設(shè)計中涉及到的各種項目，如數(shù)據(jù)項、記錄、表、數(shù)據(jù)庫等建立數(shù)據(jù)字典，以說明它們的標識符、同義名及有關(guān)信息，并說明對此數(shù)據(jù)字典設(shè)計的基本考慮。凡采用數(shù)據(jù)庫設(shè)計工具（如 ER 圖設(shè)計工具）生成的數(shù)據(jù)字典，本處僅需列出對應的文件名、保管部門即可。 安全保密設(shè)計說明在數(shù)據(jù)庫的設(shè)計中，如何通過區(qū)分不同的訪問者、不同的訪問類型和不同的數(shù)據(jù)對象，進行分別對待而獲得的數(shù)據(jù)庫安全保密設(shè)計考慮。3 / 18系統(tǒng)設(shè)計報告編寫指南之一 1. Introduction 介紹? 描述這個文檔的編寫目的；? 描述這個文檔的適用范圍；? 描述這個文檔的讀者；? 確定這個系統(tǒng)/產(chǎn)品的名稱和/或版本號；? 定義重要的術(shù)語、縮寫詞或縮略語；? 總結(jié)（或給出一個概要）這個文檔的內(nèi)容。2. System Overview 系統(tǒng)概述對軟件系統(tǒng)的一般性描述，包括系統(tǒng)的功能和其他與設(shè)計相關(guān)的內(nèi)容。3. Design Considerations 設(shè)計上的考慮本節(jié)描述在完成一個完整的設(shè)計解決方案之前必須闡明或解決的問題。 Assumptions and Dependencies 假設(shè)和依賴? 相關(guān)的軟件和硬件? 操作系統(tǒng)? 最終用戶特征? 在功能上可能發(fā)生的變化 General Constraints 一般限制? 描述對軟件系統(tǒng)的設(shè)計有重要影響的全局限制或約束。? 硬件或軟件環(huán)境；? 最終用戶環(huán)境；? 資源的可用性和揮發(fā)性；? 標準的兼容；(option)? 協(xié)同工作的要求；? 接口/協(xié)議的要求；? 數(shù)據(jù)儲存和發(fā)布要求；? 安全性的要求（或其它類似的規(guī)則）；4 / 18? 內(nèi)存和其它的容量限制；? 性能要求；? 網(wǎng)絡(luò)通信；(option)? 驗證和確認的要求（測試）；? 其他質(zhì)量目標的要求；? 在需求分析說明書中所描述的其它要求。 Goals and Guidelines 目標和指導方針描述所有支配軟件系統(tǒng)設(shè)計的目標、指導方針、原則或者優(yōu)先權(quán)。? 盡量保持它簡單易用；? 強調(diào)速度與內(nèi)存使用的矛盾；? 象像對待一個已經(jīng)存在的產(chǎn)品那樣工作、觀察或者體會。 Development Methods 開發(fā)方法簡要地描述用于軟件設(shè)計的方法。如果采用正式/已公布的方法，那么就要對這些方法進行詳細描述，同時還要簡單解釋一下為什么采用這個方法或其中的某些部分。4. Architectural Strategies 體系結(jié)構(gòu)策略描述所有影響整個系統(tǒng)的組織和結(jié)構(gòu)的設(shè)計決定和/或策略，這些策略深入描述系統(tǒng)體系結(jié)構(gòu)所使用的關(guān)鍵技術(shù)和機制。對于每個設(shè)計決定和/或策略都要描述其產(chǎn)生原因（可能要引用前面闡述的設(shè)計目標和原則），以及它們是如何得到均衡和折中的，涉及內(nèi)容：? 使用特定類型產(chǎn)品（編程語言、數(shù)據(jù)庫、函數(shù)庫等）；? 重用現(xiàn)有組件；? 軟件未來擴展和升級的計劃；? 用戶接口模型（或系統(tǒng)的輸入和輸出模型）；? 硬件或軟件接口模型；? 錯誤檢測和恢復；? 內(nèi)存管理策略；? 外部數(shù)據(jù)庫和/或數(shù)據(jù)存儲管理和維護；? 網(wǎng)絡(luò)上分布式數(shù)據(jù)或控制；? 控制的一般方法；? 并發(fā)和同步；? 通信機制；5 / 18? 其它資源的管理。每一個被采用的重要戰(zhàn)略必須在相應的子章節(jié)內(nèi)加以討論。5. System Architecture 系統(tǒng)體系結(jié)構(gòu)在本節(jié)應該在一個較高的層次來說明如何將系統(tǒng)的功能劃分給各個子系統(tǒng)或組件，不要涉及這些組件本身的細節(jié)（后面有一個小節(jié)專門來詳細描述組件）。本節(jié)的主要目標是描述系統(tǒng)是如何進行分解、這樣分解的原因以及各部分是如何協(xié)作工作以完成預定功能。在較高的層次上描述系統(tǒng)所要承擔的主要工作責任、系統(tǒng)所扮演的各種角色；描述如何將系統(tǒng)劃分成各個組件/子系統(tǒng)，每個組件/子系統(tǒng)的作用是什么；描述高層組件之間是如何協(xié)調(diào)工作已完成預期的功能；進行系統(tǒng)分解時所采用的基本原則；可以使用圖表、模型、流程圖等形式來描述上述內(nèi)容。 Subsystem Architecture 子系統(tǒng)的體系結(jié)構(gòu)建立一個子章節(jié)來詳細描述某一組件的作用，進一步描述該組件是如何分為子組件的以及各個子組件之間的關(guān)系。6. Policies and Tactics 政策和實施策略描述影響系統(tǒng)的接口細節(jié)和系統(tǒng)實現(xiàn)細節(jié)的各個方面：? 選擇特定產(chǎn)品來使用（如編譯器、解釋器、數(shù)據(jù)庫、函數(shù)庫等）；? 工程上的折中；? 編碼規(guī)范和慣例；? 一個或多個子系統(tǒng)、模塊或子程序的協(xié)議；? 選擇某一特定算法或編程用語來實現(xiàn)系統(tǒng)的一部分；? 功能性說明；? 保證需求可回溯性的計劃；? 軟件測試計劃；? 軟件維護計劃；? 最終用戶、軟件、硬件和通信的接口；? 將源代碼按照物理形態(tài)（文件和路徑）進行分層組織；? 如何構(gòu)造和/或產(chǎn)生系統(tǒng)的交付物（如何編譯、鏈接、加載等）。以上各項內(nèi)容必須有相應的子章節(jié)進行討論。如果還有其他方案可供選擇時，要說明你6 / 18沒有選擇這些方案的原因?？梢允褂脠D表、模型、流程圖等形式來描述上述內(nèi)容。7. Detailed System Design 詳細設(shè)計在系統(tǒng)體系結(jié)構(gòu)中所描述的絕大多數(shù)組件需要在本章節(jié)進行更深一步的討論，同樣，其它低層的組件和子組件也需要描述。為每個組件建立一個子章節(jié)來詳細描述組件，包括以下內(nèi)容：?
公司管理相關(guān)推薦
鄂ICP備17016276號-1