[專案名稱]
概要設計說明書
[v1.0(版本號)]
擬 制 人______________________
審 核 人______________________
批 準 人______________________
[一九九九年八月二十日]
概要設計說明書
1.引言
1.1編寫目的
[說明編寫這份概要設計說明書的目的,指出預期的讀者。]
1.2背景
a.[待開發軟體系統的名稱;]
b.[列出本專案的任務提出者、開發者、使用者。]
1.3定義
[列出本檔案中用到的專門術語的定義和外文首字母組詞的原片語。]
1.4參考資料
[列出有關的參考資料。]
2.總體設計
2.1需求規定
[說明對本系統的主要的輸入輸出專案、處理的功能效能要求。包括]
2.1.1系統功能
2.1.2系統效能
2.1.2.1精度
2.1.2.2時間特性要求
2.1.2.4可靠性
2.1.2.5靈活性
2.1.3輸入輸出要求
2.1.4資料管理能力要求
2.1.5故障處理要求
2.1.6其他專門要求
2.2執行環境
[簡要地說明對本系統的執行環境的規定。]
2.2.1裝置
[列出執行該軟體所需要的硬裝置。說明其中的新型裝置及其專門功能。]
2.2.2支援軟體
[列出支援軟體,包括要用到的作業系統、編譯(或彙編)程式、測試支援軟體等。]
2.2.3介面
[說明該系統同其他系統之間的介面、資料通訊協議等]
2.2.4控制
[說明控制該系統的執行的方法和控制訊號,並說明這些控制訊號的**。]
2.3基本設計概念和處理流程
[說明本系統的基本設計概念和處理流程,盡量使用圖表的形式。]
2.4結構
[給出系統結構總體框圖(包括軟體、硬體結構框圖),說明本系統的各模組的劃分,扼要說明每個系統模組的識別符號和功能,分層次地給出各模組之間的控制與被控制關係。]
2.5功能需求與系統模組的關係
[本條用一張矩陣圖說明各項功能需求的實現同各模組的分配關係。]
[系統模組1] [系統模組2] [……] [系統模組m]
[功能需求1] √
[功能需求2] √
[┇]
[功能需求n] √ √
2.6人工處理過程
[說明在本系統的工作過程中不得不包含的人工處理過程。]
2.7尚未解決的問題
[說明在概要設計過程中尚未解決而設計者認為在系統完成之前必須解決的各個問題。]
3.介面設計
3.1使用者介面
[說明將向使用者提供的命令和它們的語法結構,以及相應的回答資訊。]
[說明提供給使用者操作的硬體控制面板的定義。]
3.2外部介面
[說明本系統同外界的所有介面的安排包括軟體與硬體之間的介面、本系統與各支援系統之間的介面關係。]
3.3內部介面
[說明本系統之內的各個系統元素之間的介面的安排。]
4.執行設計
4.1執行模組組合
[說明對系統施加不同的外界執行控制時所引起的各種不同的執行模組組合,說明每種執行所歷經的內部模組的支援軟體。]
4.2執行控制
[說明每一種外界的執行控制的方式方法和操作步驟。]
4.3執行時間
[說明每種執行模組組合將占用各種資源的時間。]
5.系統資料結構設計
[不涉及軟體設計可不包含]
5.1邏輯結構設計要點
[給出本系統內軟體所使用的每個資料結構的名稱、識別符號以及它們之中每個資料項、記錄、文捲和系的標識、定義、長度及它們之間的層次的或**的相互關係。]
5.2物理結構設計要點
[給出本系統內軟體所使用的每個資料結構中的每個資料項的儲存要求,訪問方法、訪問單位、訪問的物理關係、設計考慮和保密條件。]
5.3資料結構與程式的關係
[說明各個資料結構與訪問這些資料結構的各個程式之間的對應關係。]
[程式1] [程式2] [……] [程式m]
[資料結構1] √
[資料結構2] √ √
┇ [資料結構n] √ √
6.系統出錯處理設計
6.1出錯資訊
[用一覽表的方式說明每種可能的出錯或故障情況出現時,系統輸出資訊的形式、含意及處理方法。]
6.2補救措施
[說明故障出現後可能採取的變通措施。包括:]
a.後備技術 [說明準備採用的後備技術,當原始系統資料萬一丟失時啟用的副本的建立和啟動的技術,例如周期性地把磁碟資訊記錄到磁帶上去就是對於磁碟**的一種後備技術。]
b.降效技術 [說明準備採用的後備技術,使用另乙個效率稍低的系統或方法來求得所需結果的某些部分,例如乙個自動系統的降效技術可以是手工操作和資料的人工記錄。]
c.恢復及再啟動技術 [說明將使用的恢復再啟動技術,使軟體從故障點恢復執行或使軟體從頭開始重新執行的方法。]
6.3系統維護設計
[說明為了系統維護的方便而在程式內部設計中作出的安排,包括在程式中專門安排用於系統的檢查與維護的檢測點和專用模組。]
軟體開發設計文件模版
開發團隊 部門 組長 組員 備註 可以把上面的內容放在乙個好看的封面頁上。文件更新記錄 版本說明 完成日期 修改人建立文件 對專案的背景進行介紹 比如為什麼要開發這個系統 對整個系統的情況進行介紹。列舉參考的文件 該系統需要完成的基本功能,對系統的大體描述 該系統涉及的開源專案等 本設計文件作為xx...
工程設計 軟體開發的設計文件
翻譯 1 需要實現哪些功能 2 需要執行在什麼樣的環境,多快的執行 3 可能失敗的場景,解決方案 4 安裝以及首次執行需要做哪些事情 5 使用者使用限制 原則上說,就是盡量細緻,這樣可以避免錯誤,和誤解。而誤解和錯誤的設計可能會導致 的重寫。根據提供的軟體產品,制定一系列的里程碑。里程碑可以保證專案...
軟體開發 如何寫軟體開發文件
3.程式設計實現 4.整合 5.測試 6.維護 依據什麼需求,開發出什麼 硬體開發平台 nvidia jetson tx2 工業相機 作業系統 ubuntu 16.04 開發平台 ros 程式語言 python c 系統包含 資料採集 演算法實現 結果輸出 在某某硬體平台上安裝某某作業系統,安裝ro...