1. 項目概況
1.1. 背景
寫項目的來龍去脈
1.2. 項目願景
寫該項目達到的目的。
例如
建設該項目是為了提高本區域的地質災害預警預報的及時性。
1.3. 項目干系人
和該項目相關的人員和其負責的內容
在這里要找到主要干系人,也就是說能對系統功能拍板的人。
1.4. 運行環境
項目的運行環境,包括硬件環境和軟件環境
1.5. 條件與限制
硬件條件限制、例如只能購買一台服務器,網絡條件限制,只能走政務內網或局域網。或者已經指定了數據庫和開發平台,開發語言等。還有工期等。
2. 數據需求
2.1. 數據列表
項目一共需要哪些數據,數據的格式要求等。並標注好哪些數據已有,哪些數據還沒有,誰負責,什么時候提交等信息。
2.2. 數據格式需求
例如空間數據,系統需要什么空間參考的空間數據,格式是什么,是.shape文件還是.gdb文件夾。
屬性數據是需要什么格式,可以是excel。但每個數據Excel文件具體什么格式,我們在設計文檔里面可以定義。
3. 業務功能需求
該模塊主要描述系統主要的業務流程圖和整理出來的用例圖以及用例規約。
下圖為業務流程圖示例:
下圖為業務用例示例:
下表為一個業務用例規約:
用例名稱 |
區域預警分析 |
執行者 |
預警中心工作人員 |
前置條件 |
已經有了氣象部門提供的當前雨量和未來24小時雨量數據 |
后置條件 |
生成預警分析結果 |
涉眾利益 |
預警中心工作人員:擔心操作太復雜。 領導:擔心時間操作長,預報不及時。 |
基本路徑 |
1. 執行者選擇氣象部門給的雨量文件,設置預報的時間范圍。 2. 系統新建了一個預警工程,並在地圖上展示出來,並且標注好預報雨量數據。 3. 執行者點擊區域預警分析,執行分析。 4. 分析后檢查無誤,執行生成預警結果操作。 |
擴展路徑 |
a. 氣象部門給的雨量文件不符合規范 1. 在導入雨量文件的時候,檢查雨量文件格式,如果格式有問題,就提示用戶。 2. 用例結束。 b. 用戶選擇的時間范圍不對 1. 如果用戶選擇的開始時間大小或等於結束時間,則提示用戶。 2. 用例結束。 |
業務規則 |
1. 氣象台給的雨量數據是有固定的格式的。 2. 氣象台給的雨量數據文件中包含的區域必須和系統中區域名稱一致。 3. 預警的時間范圍,起始時間必須小於終止時間。 |
非功能需求 |
1. 不要讓用戶選擇工程的路徑,默認保存在系統的某一路徑下。 2. 在新建過程中,可以按照默認的信息新建一個工程,不需要任何新的輸入。 |
涉及約束 |
4. 系統功能需求
在此列出系統有哪些模塊,每個模塊包含的字模塊和功能列表。
子系統 |
模塊 |
子模塊 |
功能 |
后面描述每個功能的作用。(簡單描述即可)最好可以畫一些界面。
5. 外部接口需求
界面風格。
外部硬件接口
外部軟件接口
故障處理等
6. 性能需求
響應時間
無故障運行時間
其他特殊操作對性能的要求