軟體系統介紹文件模板

概述

開發背景

【比如為什麼要開發這個系統】

開發目標

【該系統需要完成的基本功能，對系統的大體描述】

參考資料

【該系統涉及的開源專案等】

設計原則

【設計該系統遵守的原則，比如支援多資料庫，可移植行，可擴充性等】

需求分析

需求陳述

【用平常語言描述該系統的全部功能和細節】

操作用例

【描述具體的操作例子，比如登入後進行何種操作】

功能分析劃分

【分析功能並劃分功能塊】

系統登入

【比如，需要實現兩種登入模組，普通登入，管理員登入，並且描述可能出現的各種情況以及問題處理】

使用者管理

【比如：實現使用者顯示，新增，刪除，修改】

……

執行環境

總體設計

系統建模

層次方框圖

【從頂部開始，按照層次分類進行細化】

ER圖（實體-聯絡圖）

【分析各個物件之間的聯絡，畫圖ER圖】

介面設計

類圖設計

【使用UML畫出各個類的屬性、繼承和方法】

介面設計

【各個子系統之間的介面和使用者介面】

內部介面設計

【各個部件是通過何種方式進行連線，比如通過遠端資料庫，http等】

登入介面設計

使用者管理介面設計

……

資料庫結構設計

【主要是描述】

資料庫E-R圖

資料庫邏輯設計

出錯處理

【描述如果出錯的處理方法】

安全保密設計

【描述採用何種方法保證安全性】

詳細設計

程式流程圖

【具體來說就是把經過總體設計得到的各個模組詳細的加以描述。】

虛擬碼編寫

【使用中文或者英文進行虛擬碼編寫，以後這些虛擬碼將會成為程式碼的註釋】

實現

編碼

程式碼約定

程式碼編寫原則

測試要點

登入測試要點

【描述該如何測試，資料的輸入，型別】

主介面測試要點

……

測試結果和總結

維護

維護方法

維護文件

功能擴充方法