開發(fā)文檔需求規(guī)格說明書格式

1、年4月19日開發(fā)文檔需求規(guī)格說明書格式文檔僅供參考，不當(dāng)之處，請聯(lián)系改正。江東區(qū)經(jīng)濟(jì)社會綜合統(tǒng)計(jì)信息平臺需求規(guī)格說明書寧波優(yōu)創(chuàng)信息技術(shù)有限公司二零一零年八月項(xiàng)目編號分發(fā)號版本號1.00受控狀態(tài)受控XXXXXXXXX系統(tǒng)需求規(guī)格說明書項(xiàng)目承擔(dān)部門： 撰寫人（簽名）： 完 成 日 期： 需求提供人（簽名）： 提 供 日 期：評審人（簽名）： 評 審 日 期： 批準(zhǔn)人（簽名）： 批 準(zhǔn) 日 期：文檔控制頁編號章節(jié)名稱修訂內(nèi)容簡述修訂日期修訂前版本修訂后版本修訂人批準(zhǔn)人1全文創(chuàng)立 -10-271.0劉麗鵑江文2全文修訂 -02-201.3肖煜林江文3全文修訂 -02-241.7劉麗鵑江文4全文修訂 -

2、07-252.0肖煜林江文目 錄 TOC o 1-3 h z u HYPERLINK l _Toc 1.引言 PAGEREF _Toc h 1 HYPERLINK l _Toc 1.1編寫目的 PAGEREF _Toc h 1 HYPERLINK l _Toc 1.2項(xiàng)目背景 PAGEREF _Toc h 1 HYPERLINK l _Toc 1.3參考資料 PAGEREF _Toc h 1 HYPERLINK l _Toc 2.總體概述 PAGEREF _Toc h 2 HYPERLINK l _Toc 2.1軟件標(biāo)識 PAGEREF _Toc h 2 HYPERLINK l _Toc 2.

3、2產(chǎn)品描述 PAGEREF _Toc h 2 HYPERLINK l _Toc 2.3用戶特點(diǎn) PAGEREF _Toc h 2 HYPERLINK l _Toc 2.4開發(fā)工具 PAGEREF _Toc h 2 HYPERLINK l _Toc 3.功能列表 PAGEREF _Toc h 3 HYPERLINK l _Toc 4.功能描述 PAGEREF _Toc h 3 HYPERLINK l _Toc 4.1業(yè)務(wù)登記 PAGEREF _Toc h 4 HYPERLINK l _Toc 4.2功能一 PAGEREF _Toc h 5 HYPERLINK l _Toc 4.3功能二 PAGE

4、REF _Toc h 7 HYPERLINK l _Toc 5.角色設(shè)置 PAGEREF _Toc h 8 HYPERLINK l _Toc 6.初始化數(shù)據(jù) PAGEREF _Toc h 8 HYPERLINK l _Toc 7.一般約束 PAGEREF _Toc h 8 HYPERLINK l _Toc 7.1硬件約束 PAGEREF _Toc h 8 HYPERLINK l _Toc 7.2安全性 PAGEREF _Toc h 9 HYPERLINK l _Toc 7.3可用性 PAGEREF _Toc h 9 HYPERLINK l _Toc 7.4性能要求 PAGEREF _Toc h

5、 9 HYPERLINK l _Toc 7.5數(shù)據(jù)庫要求 PAGEREF _Toc h 9 HYPERLINK l _Toc 7.6管理維護(hù)方針 PAGEREF _Toc h 9 HYPERLINK l _Toc 7.7并行操作 PAGEREF _Toc h 9 HYPERLINK l _Toc 7.8可移植性 PAGEREF _Toc h 10 HYPERLINK l _Toc 7.9其它標(biāo)準(zhǔn)的約束 PAGEREF _Toc h 10 HYPERLINK l _Toc 8.外部接口要求 PAGEREF _Toc h 10 HYPERLINK l _Toc 8.1用戶接口 PAGEREF _T

6、oc h 10 HYPERLINK l _Toc 8.2硬件接口 PAGEREF _Toc h 10 HYPERLINK l _Toc 8.3軟件接口 PAGEREF _Toc h 11 HYPERLINK l _Toc 8.4通信接口 PAGEREF _Toc h 11 HYPERLINK l _Toc 8.5假設(shè)和依據(jù) PAGEREF _Toc h 11引言編寫目的說明編寫這份軟件需求說明書的目的，指出預(yù)期的讀者范圍。如（定義軟件總體要求，作為用戶、軟件開發(fā)人員以及其它干系人之間溝通的基礎(chǔ)；描述功能要求、性能要求、用戶和系統(tǒng)的接口要求、數(shù)據(jù)庫等內(nèi)容，作為軟件開發(fā)人員進(jìn)行軟件結(jié)構(gòu)設(shè)計(jì)、編碼的

7、基礎(chǔ)；作為軟件總體測試的依據(jù)。）等編寫需求說明書的目的是作為軟件開發(fā)方與客戶方的溝通軟件需求的一個依據(jù)，將具體的需求文字化能夠消除雙方在語言表述、理解方面的誤差。需求說明書除具體的功能需求外，還包括項(xiàng)目開發(fā)時一般要確定的事項(xiàng)。需求說明書要得到軟件開發(fā)方、客戶方的簽字確認(rèn)。需求說明書是項(xiàng)目設(shè)計(jì)人員設(shè)計(jì)項(xiàng)目實(shí)現(xiàn)的基礎(chǔ)。項(xiàng)目背景列出本文件中用到的專門術(shù)語的定義和縮寫詞的原詞組。如下：甲方：xxx有限公司。乙方：xxx有限公司。招標(biāo)書：由甲方提供的招投標(biāo)技術(shù)規(guī)范書。投標(biāo)書：由乙方提供的技術(shù)方案書。參考資料列出要用到的參考資料，如：本項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同、上級機(jī)關(guān)的批文；屬于本項(xiàng)目的其它已發(fā)表

8、的文件；本文件中各處引用的文件、資料，包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件的標(biāo)題、文件編號、發(fā)表日期和出版單位，說明能夠得到這些文件資料的來源。招標(biāo)書投標(biāo)書項(xiàng)目管理制度xxxx質(zhì)量管理體系文件ISO 9001： 軟件工程國家標(biāo)準(zhǔn)匯編總體概述軟件標(biāo)識項(xiàng)目名稱：尚學(xué)堂Web OA管理系統(tǒng)；項(xiàng)目編號：U0055產(chǎn)品范圍：按照招標(biāo)書中5.2的規(guī)定執(zhí)行。產(chǎn)品名稱：產(chǎn)品簡稱：版本號：1.00產(chǎn)品描述敘述該項(xiàng)軟件開發(fā)的意圖、應(yīng)用目標(biāo)、作用范圍以及其它應(yīng)向讀者說明的有關(guān)該軟件開發(fā)的背景材料。解釋被開發(fā)軟件與其它有關(guān)軟件之間的關(guān)系。如果本軟件產(chǎn)品是一項(xiàng)獨(dú)立的軟件，而且全部內(nèi)容自含，則說明這一點(diǎn)。如果所定義的

9、產(chǎn)品是一個更大的系統(tǒng)的一個組成部分，則應(yīng)說明本產(chǎn)品與該系統(tǒng)中其它各組成部分之間的關(guān)系，為此可使用一張方框圖來說。用戶特點(diǎn)列出本軟件的最終用戶的特點(diǎn)，充分說明操作人員、維護(hù)人員的教育水平和技術(shù)專長，以及本軟件的預(yù)期使用頻度。這些是軟件設(shè)計(jì)工作的重要約束。確認(rèn)用戶人群的操作偏好，如以前、最近是否有使用順手的軟件系統(tǒng)，有沒有特定的操作偏好。開發(fā)工具應(yīng)用程序語言：JAVA 版本號1.6應(yīng)用程序服務(wù)器：tomcat 版本號6.0操作系統(tǒng)：Windows XP模型工具：Powerdesign編碼工具：Eclipse、Myeclipse數(shù)據(jù)庫名稱：MYSQL 版本號5.0 數(shù)據(jù)庫要考慮是開源免費(fèi)的，還是收費(fèi)

10、的，收費(fèi)的金額功能列表按照層次結(jié)構(gòu)列出項(xiàng)目的功能清單。序號功能名稱功能需求標(biāo)識優(yōu)先級簡要描述個人辦公我的辦公桌高打開個人辦公桌，在個人辦公桌上，是到達(dá)各種管理功能的快捷鏈接我的便簽低隨手記錄的信息我的任務(wù)低任務(wù)管理通信錄低個人通信錄公文管理公文維護(hù)高各種類型的公文管理、審批公文等歸檔處理高對已完成流轉(zhuǎn)的公文進(jìn)行歸檔功能描述對于每一個功能、一類功能，具體描述其基本信息、引言、工作流需求、可選異常事件流、補(bǔ)充規(guī)約。基本信息基本信息包括模塊名稱、主要角色、前置條件、后置條件、用戶操作。引言描述功能的意圖、目標(biāo)，采用的方法和技術(shù)，必要時說明功能由來、背景。工作流（輸入、加工、輸出）用順序表格的方式詳細(xì)

11、描述功能的工作流，類似的工作流在不影響用戶理解的情況下能夠合并描述。工作流的模式為“用戶操作系統(tǒng)處理系統(tǒng)輸出”，分別對應(yīng)輸入、加工、輸出。一連串不間斷的操作為一個工作流。工作流之間使用空白行分隔。輸入：詳細(xì)描述用戶操作時的輸入數(shù)據(jù)、輸入限制，操作方式（用戶的頁面事件，如點(diǎn)擊鏈接、提交表單等）；客戶顯示要求時，說明操作細(xì)節(jié)的需求。如下拉菜單聯(lián)動，過濾等；必要時說明實(shí)現(xiàn)、引用的接口及其控制參數(shù)。加工：描述把用戶輸入轉(zhuǎn)換成相應(yīng)輸出的任何方法（腳本操作、數(shù)據(jù)庫操作、邏輯處理等）。輸出：詳細(xì)描述該功能輸出數(shù)據(jù)，如：文件輸出、數(shù)據(jù)列表、頁面刷新等?？蛇x、異常事件流參照工作流補(bǔ)充規(guī)約描述其它條目中不便說明的

12、補(bǔ)充事項(xiàng)。如特定的代碼的數(shù)據(jù)規(guī)則等。業(yè)務(wù)登記R001業(yè)務(wù)登記主要角色經(jīng)營部業(yè)務(wù)室前置條件用戶已經(jīng)登錄后置條件用戶將業(yè)務(wù)記錄到系統(tǒng)中用戶操作增加、編輯、刪除、提交引言：功能意圖、目標(biāo)相關(guān)方法、技術(shù)典型事件流步驟號用戶系統(tǒng)業(yè)務(wù)信息的增加、修改流程界面初始時顯示系統(tǒng)已有業(yè)務(wù)登記列表選擇“新增”、“修改”功能載入可填寫表單輸入：法人代表、客戶名稱、聯(lián)系電話、聯(lián)系人、聯(lián)系地址、稅務(wù)登記證，開戶銀行帳號、登記人、登記日期、項(xiàng)目編號、項(xiàng)目名稱、工程類別，項(xiàng)目內(nèi)容，設(shè)計(jì)圖完工日期，工程竣工日期，附件上傳表單校驗(yàn)規(guī)則：除附件外都是必填項(xiàng)選擇“增加”、“保存”按扭表單校驗(yàn)，校驗(yàn)失敗時提示，校驗(yàn)成功時流程繼續(xù)服務(wù)器

13、成功保存數(shù)據(jù)系統(tǒng)顯示已有業(yè)務(wù)登記列表提示下一階段的流向選擇工程部現(xiàn)場查勘和物資部設(shè)備清單反饋服務(wù)器保存數(shù)據(jù)失敗系統(tǒng)跳轉(zhuǎn)到異常提示頁面業(yè)務(wù)信息的刪除流程選擇“刪除”功能服務(wù)器刪除對應(yīng)數(shù)據(jù)系統(tǒng)顯示已有業(yè)務(wù)登記列表提示數(shù)據(jù)刪除成功可選、異常事件流補(bǔ)充規(guī)約（技術(shù)規(guī)則或數(shù)據(jù)細(xì)節(jié)等）項(xiàng)目編號由系統(tǒng)自動產(chǎn)生，規(guī)則“工程屬性+年份+區(qū)域+流水號”，工程屬性為管理辦法中的四個工程類型，本需求中只涉及客戶業(yè)擴(kuò)工程（專變），編號為ZB，年份用四位表示，如 ；區(qū)域用兩位數(shù)表示：01江東，02江北，03海曙；流水號用三位數(shù)表示：001；例“01- -01-001附件上傳部分參加用例29工程類別分為以下幾種：用戶專變：新

14、裝（高供高計(jì)）、新裝（高供低計(jì)）、臨時變、增（減）容 事故處理：網(wǎng)內(nèi)工程、用戶工程網(wǎng)內(nèi)工程：基建，技改，大修小區(qū)變工程用戶遷移或改道工程（黃色部分不在本期項(xiàng)目內(nèi)）回退信息的顯示：回退人，回退時間，回退內(nèi)容，回退階段；按時間倒序顯示，即最近的顯示最前面功能一R002業(yè)務(wù)登記主要角色經(jīng)營部業(yè)務(wù)室前置條件用戶已經(jīng)登錄后置條件用戶將業(yè)務(wù)記錄到系統(tǒng)中用戶操作增加、編輯、刪除、提交引言：功能意圖、目標(biāo)相關(guān)方法、技術(shù)典型事件流步驟號用戶系統(tǒng)業(yè)務(wù)信息的增加、修改流程界面初始時顯示系統(tǒng)已有業(yè)務(wù)登記列表選擇“新增”、“修改”功能載入可填寫表單輸入：法人代表、客戶名稱、聯(lián)系電話、聯(lián)系人、聯(lián)系地址、稅務(wù)登記證，開戶銀

15、行帳號、登記人、登記日期、項(xiàng)目編號、項(xiàng)目名稱、工程類別，項(xiàng)目內(nèi)容，設(shè)計(jì)圖完工日期，工程竣工日期，附件上傳表單校驗(yàn)規(guī)則：除附件外都是必填項(xiàng)選擇“增加”、“保存”按扭表單校驗(yàn)，校驗(yàn)失敗時提示，校驗(yàn)成功時流程繼續(xù)服務(wù)器成功保存數(shù)據(jù)系統(tǒng)顯示已有業(yè)務(wù)登記列表提示下一階段的流向選擇工程部現(xiàn)場查勘和物資部設(shè)備清單反饋服務(wù)器保存數(shù)據(jù)失敗系統(tǒng)跳轉(zhuǎn)到異常提示頁面業(yè)務(wù)信息的刪除流程選擇“刪除”功能服務(wù)器刪除對應(yīng)數(shù)據(jù)系統(tǒng)顯示已有業(yè)務(wù)登記列表提示數(shù)據(jù)刪除成功可選、異常事件流補(bǔ)充規(guī)約（技術(shù)規(guī)則或數(shù)據(jù)細(xì)節(jié)等）項(xiàng)目編號由系統(tǒng)自動產(chǎn)生，規(guī)則“工程屬性+年份+區(qū)域+流水號”，工程屬性為管理辦法中的四個工程類型，本需求中只涉及客戶

16、業(yè)擴(kuò)工程（專變），編號為ZB，年份用四位表示，如 ；區(qū)域用兩位數(shù)表示：01江東，02江北，03海曙；流水號用三位數(shù)表示：001；例“01- -01-001附件上傳部分參加用例29工程類別分為以下幾種：用戶專變：新裝（高供高計(jì)）、新裝（高供低計(jì)）、臨時變、增（減）容 事故處理：網(wǎng)內(nèi)工程、用戶工程網(wǎng)內(nèi)工程：基建，技改，大修小區(qū)變工程用戶遷移或改道工程（黃色部分不在本期項(xiàng)目內(nèi)）回退信息的顯示：回退人，回退時間，回退內(nèi)容，回退階段；按時間倒序顯示，即最近的顯示最前面功能二R001業(yè)務(wù)登記主要角色經(jīng)營部業(yè)務(wù)室前置條件用戶已經(jīng)登錄后置條件用戶將業(yè)務(wù)記錄到系統(tǒng)中用戶操作增加、編輯、刪除、提交引言：功能意圖、

17、目標(biāo)相關(guān)方法、技術(shù)典型事件流步驟號用戶系統(tǒng)業(yè)務(wù)信息的增加、修改流程界面初始時顯示系統(tǒng)已有業(yè)務(wù)登記列表選擇“新增”、“修改”功能載入可填寫表單輸入：法人代表、客戶名稱、聯(lián)系電話、聯(lián)系人、聯(lián)系地址、稅務(wù)登記證，開戶銀行帳號、登記人、登記日期、項(xiàng)目編號、項(xiàng)目名稱、工程類別，項(xiàng)目內(nèi)容，設(shè)計(jì)圖完工日期，工程竣工日期，附件上傳表單校驗(yàn)規(guī)則：除附件外都是必填項(xiàng)選擇“增加”、“保存”按扭表單校驗(yàn)，校驗(yàn)失敗時提示，校驗(yàn)成功時流程繼續(xù)服務(wù)器成功保存數(shù)據(jù)系統(tǒng)顯示已有業(yè)務(wù)登記列表提示下一階段的流向選擇工程部現(xiàn)場查勘和物資部設(shè)備清單反饋服務(wù)器保存數(shù)據(jù)失敗系統(tǒng)跳轉(zhuǎn)到異常提示頁面業(yè)務(wù)信息的刪除流程選擇“刪除”功能服務(wù)器刪除

18、對應(yīng)數(shù)據(jù)系統(tǒng)顯示已有業(yè)務(wù)登記列表提示數(shù)據(jù)刪除成功可選、異常事件流補(bǔ)充規(guī)約（技術(shù)規(guī)則或數(shù)據(jù)細(xì)節(jié)等）項(xiàng)目編號由系統(tǒng)自動產(chǎn)生，規(guī)則“工程屬性+年份+區(qū)域+流水號”，工程屬性為管理辦法中的四個工程類型，本需求中只涉及客戶業(yè)擴(kuò)工程（專變），編號為ZB，年份用四位表示，如 ；區(qū)域用兩位數(shù)表示：01江東，02江北，03海曙；流水號用三位數(shù)表示：001；例“01- -01-001附件上傳部分參加用例29工程類別分為以下幾種：用戶專變：新裝（高供高計(jì)）、新裝（高供低計(jì)）、臨時變、增（減）容 事故處理：網(wǎng)內(nèi)工程、用戶工程網(wǎng)內(nèi)工程：基建，技改，大修小區(qū)變工程用戶遷移或改道工程（黃色部分不在本期項(xiàng)目內(nèi)）回退信息的顯示

19、：回退人，回退時間，回退內(nèi)容，回退階段；按時間倒序顯示，即最近的顯示最前面角色設(shè)置列出角色的分類名稱，簡述各角色的權(quán)限、職責(zé)范圍。初始化數(shù)據(jù)列出系統(tǒng)初始化時需要錄入哪些數(shù)據(jù)。如用戶信息初始化等。一般約束本條各小節(jié)對設(shè)計(jì)系統(tǒng)時限制開發(fā)者選擇的其它項(xiàng)作一般性描述。而這些項(xiàng)將限定開發(fā)者在設(shè)計(jì)系統(tǒng)時的任選項(xiàng)。硬件約束本條包括各種軟件運(yùn)行的硬件約束，如：硬件的詳細(xì)配置；硬件的負(fù)載，如只運(yùn)行本系統(tǒng)，還是和其它系統(tǒng)共用。安全性說明如何保護(hù)軟件，以防止偶然或惡意的訪問、使用、修改或泄密。這個領(lǐng)域的具體需求必須包括：利用可靠的密碼技術(shù)；防止SQL注入；區(qū)分用戶權(quán)限；選擇性的是使用CA證書； 可用性能夠指定一些因

20、素，如檢查點(diǎn)、恢復(fù)和再啟動等，以保證整個系統(tǒng)有一個確定的可用性級別。即當(dāng)系統(tǒng)出現(xiàn)異常時執(zhí)行什么樣的操作能保證系統(tǒng)再次正常運(yùn)行，以及這種操作是否有何種負(fù)面影響。性能要求本條說明軟件數(shù)據(jù)處理能力和時間特性的需求。數(shù)據(jù)處理能力可能包括：支持的終端數(shù)、支持并行操作的用戶數(shù)、處理的文件和記錄數(shù)、表和文件的大小。時間特性可能包括：響應(yīng)時間、更新處理時間、數(shù)據(jù)的轉(zhuǎn)換和傳送時間、運(yùn)行時間等。數(shù)據(jù)庫要求本條說明對軟件應(yīng)用的數(shù)據(jù)庫的需求，如：數(shù)據(jù)庫名稱、版本、數(shù)據(jù)項(xiàng)、記錄、文件標(biāo)識、靜態(tài)和動態(tài)的組織、存取能力等。存儲特性：數(shù)據(jù)庫的編碼方式，備份方式，可能的最大字節(jié)數(shù)。管理維護(hù)方針描述軟件啟動、關(guān)閉的管理方式。描述

21、軟件內(nèi)容日常維護(hù)、管理的方式。并行操作本條描述是否存在兩個用戶同一時刻操作同一條數(shù)據(jù)庫記錄的可能性，以及在這種情況是否要實(shí)現(xiàn)數(shù)據(jù)的保護(hù)、同步?？梢浦残哉f明軟件對軟、硬件環(huán)境的兼容，它從一個環(huán)境移植到另一個環(huán)境的約束等。其它標(biāo)準(zhǔn)的約束本條描述由現(xiàn)有的標(biāo)準(zhǔn)或規(guī)則派生的要求，如：報(bào)表格式數(shù)據(jù)命名會計(jì)準(zhǔn)則審計(jì)追蹤等等。外部接口要求用戶接口本條說明為方便用戶使用而提出的軟件與用戶界面的需求。如：屏幕格式瀏覽器支持類型報(bào)表格式菜單格式功能鍵的使用，如回車等快捷鍵。表單的操作要求，如回車提交，TAB切換等。硬件接口本條說明軟件與硬件間各接口，可使用接口框圖進(jìn)行說明。說明內(nèi)容包括：接口標(biāo)識功能描述信號方向、格式、傳輸協(xié)議優(yōu)先級響應(yīng)時間異常處理對每一硬件，需提供名稱、縮寫、型號、數(shù)量，并說明其功能。軟件接口本條指定需使用的其它軟件產(chǎn)品（如：數(shù)據(jù)管理系統(tǒng)、操作系統(tǒng)、數(shù)學(xué)軟件包），以及同其它應(yīng)用系統(tǒng)之間的接口。如果已有完整的接