1.1. 背景
說明:
a.待開發的軟件系統的名稱;
b.本項目的任務提出者、開發者、用戶及實現該軟件的計算中心或計算機網絡;
C.該軟件系統同其他系統或其他機構的基本的相互來往關系。
1.2. 參考資料
列出本說明書中引用和參考的資料,如:
a.本項目的經核準的計劃任務書或合同、上級機關的批文;
b.屬於本項目的其他已發表的文件;
c.本文件中各處引用的文件、資料、包括所要用到的軟件開發標準。 列出這些文件資料的標題、文件編號、發表日期和出版單位,說明能夠得到這些文件資料的來源。
1.3. 假定和約束[可選]
列出進行本軟件開發工作的假定和約束,例如經費限制、開發期限、設備條件、用戶的資料準備和交流上的問題等。
1.4. 用戶的特點[可選]
列出本軟件的最終用戶的特點,充分說明操作人員、維護人員的教育水平和技術專長,以及本軟件的預期使用頻度。這些是軟件設計工作的重要約束。
2. 功能需求
2.1. 系統範圍
明確概要地說明用戶對系統、產品高層次的目標要求,如系統開發的意圖、應用目標、作用範圍以及其他相關的背景材料。
如果所定義的產品是壹個更大系統的壹個組成部分,則應說明本產品與該系統中其他各組成部分之間的關系,為此可使用壹張方框圖來說明該系統的組成和本產品同其他各部分的聯系和接口。
2.2. 系統體系結構(二層架構的系統可剪裁本小節)[可選]
以圖+文本結合的方式描述系統的總體架構。
以下應提供系統總體架構圖:
以下對系統總體架構進行描述:
2.3. 系統總體流程
以圖+文本結合的方式說明系統的總體流程。
圖壹是計劃合同管理系統的總體流程圖。
圖壹
2.4. 需求分析
需求分析的目的是獲取或描述系統需求中的每壹個功能需求,並通過分析確定系統能夠做什麽?誰來使用這個系統?
· 建立用例模型:發現角色和用例,並確定角色之間的關系、用例之間的關系,以及角色與用例之間的相互關系
· 描述用例:角色與系統如何交互的規格說明。
2.4.1. XXXXXXX(功能需求名稱)
2.4.1.1. 功能描述
功能編號:
功能需求:從用戶業務的角度描述功能需求。
2.4.1.2. 業務建模
從可視化的角度--用例圖--描述功能需求
圖二是綜合計劃管理系統合同編輯業務的功能需求用例圖。
圖二
2.4.1.3. 用例描述
以文本的方式描述每壹個用例中角色與系統相互交互的規格說明。
1、 XXXXXX(用例名稱)
描述對象 描述內容
標識符 用例的唯壹標識符
說明 對用例的概要說明
參與者 與該用例相關的參與者列表,以及參與者的特點
頻度 參與者訪問此用例的頻率
狀態 通常分為:進行中、等待審查、通過審查或未通過審查
前置條件 壹個條件列表,如果其中包含條件,則這些條件必須在訪問用例之前得到滿足
後置條件 壹個條件列表,如果其中包含條件,則這些條件將在用例成功完成以後得到滿足
被擴展的用例 此用例所擴展的用例(如果存在)
被包含的用例 此用例所包含的用例(如果存在)
基本操作流程 參與者在用例中所遵循的主邏輯路徑,即當各項工作都正常進行時用例的工作方式
可選操作流程 在變更工作方式、出現異常或發生錯誤的情況下所遵循的路徑
修改歷史記錄 修改人 : 修改日期:修改原因:
問題 如果存在,則為與此用例的開發相關的問題或操作項目的列表
以下是綜合計劃管理系統中的合同編輯功能需求中的合同增加用例描述:
描述對象 描述內容
標識符 IPMS0101
說明 增加壹條合同記錄
參與者 合同編輯人員--熟悉合同管理業務
頻度
狀態 通過審查
前置條件 1. 參與者具有合同增加的權限2. 參與者已選取對應的計劃記錄3. 當前計劃總投資≥SUM(該計劃下已簽合同價)
後置條件 1. 數據庫中更加壹條合同紀律2. 可執行合同原件掃描用例3. 可執行合同付款增加用例4. 可執行合同修改和合同刪除用例
被擴展的用例 無
被包含的用例 無
基本操作流程 請參見圖三的合同增加流程
可選操作流程 當用戶確認合同增加時發現異常時,系統提示合同增加無效的提示
修改歷史記錄 修改人 : 修改日期:修改原因:
問題 1. 合同編碼的具體約定2. 合同類型、資金來源、合同受委托方字典表的具體設計
圖三 合同增加活動流程
2、XXXXX(用例名稱)
……
2.4.1.4. 用戶界面
概要描述功能對應的用戶界面風格,采用原型生命周期的項目也可以提供原型界面拷貝。
2.4.2. XXXXXXX(功能需求名稱)
……
3. 非功能需求
3.1. 性能要求
3.1.1. 精度[可選]
說明對該軟件的輸入、輸出數據精度的要求,可能包括傳輸過程中的精度。
3.1.2. 時間特性要求
說明對於該軟件的時間特性要求,如對:響應時間;更新處理時間;數據的轉換和界面更新傳送時間等的要求。
3.1.3. 輸人輸出要求
解釋各輸入輸出數據類型,並逐項說明其媒體、格式、數值範圍、精度等。對軟件的數據輸出及必須標明的控制輸出量進行解釋並舉例,包括對硬拷貝報告(正常結果輸出、狀態輸出及異常輸出)以及圖形或顯示報告的描述。
3.2. 數據管理能力要求[可選]
說明需要管理的文卷和記錄的個數、表和文卷的大小規模,要按可預見的增長對數據及其分量的存儲要求做出估算。
3.3. 安全保密性要求
用戶對系統所應具備的故障處理能力、處理方式及故障後的系統恢復、數據恢復等要求,對系統防止機密數據被非法侵入、修改及丟失的要求。
3.4. 靈活性要求[可選]
說明對該軟件的靈活性的要求,即當需求發生某些變化時,該軟件對這些變化的適應能力,如:
a.操作方式上的變化;
b.運行環境的變化;
c.同其他軟件的接口的變化;
d.精度和有效時限的變化;
e.計劃的變化或改進。
對於為了提供這些靈活性而進行的專門設計的部分應該加以標明。
3.5. 其他專門要求[可選]
如用戶單位對使用方便的要求,對可維護性、可補充性、易讀性、可靠性、異常處理要求、運行環境可轉換性的特殊要求等。
4. 運行環境規定
4.1. 設備
列出運行該軟件所需要的硬設備。說明其中的新型設備及其專門功能,包括:
a.處理器型號及內存容量;
b.外存容量、聯機或脫機、媒體及其存儲格式,設備的型號及數量;
c.輸入及輸出設備的型號和數量,聯機或脫機;
d.數據通信設備的型號和數量;
e.功能鍵及其他專用硬件
4.2. 支持軟件
列出支持軟件,包括網絡和硬件設備平臺、操作系統平臺、數據庫系統平臺以及編譯(或匯編)程序和測試支持軟件等。
4.3. 接口[可選]
說明該軟件同其他軟件之間的接口、數據通信協議等。
4.4. 控制[可選]
說明控制該軟件的運行的方法和控制信號,並說明這些控制信號的來源。
5. 需求跟蹤
需求跟蹤的主要目的是保證所有的需求都得到分析,以承諾需求-分析需求對應表(PRS_SRS表)的方式描述已分析需求對已承諾需求的覆蓋情況。PRS_SRS表的格式請參見軟件需求管理過程規範(SUPL-MANU-SRS-001)。