某X項目開發(fā)軟件設計規(guī)格使用說明標準規(guī)定模板

1、附件三XXX項目軟件設計規(guī)格說明書版本<1.0>文檔信息項目名稱項目編號文檔名稱設計規(guī)格說明書存儲位置版本作者/修改者日期描述33目錄1概述1.1編寫目的1.2編寫依據1.3術語和縮略詞2軟件概要2.1軟件總體描述2.2軟件設計約束及有關說明2.3使用者特點3開發(fā)和運行環(huán)境3.1硬件環(huán)境3.2支持軟件環(huán)境3.3 接口3.4控制和操作4詳細需求4.1性能需求4.2功能需求.1.0.4.3數據需求.1.3.5故障處理需求.14,5.1軟件運行故障.14,5.2軟件使用故障.14,6質量需求1.6.7其他需求1.7.7.1易用性需求177.2安全性需求171概述1.1編寫目的指出編寫需求

2、規(guī)格說明書的目的。下面是示例:編寫此文檔的目的是進一步定制軟件開發(fā)的細節(jié)問題， 希望能使本軟件開發(fā)工作更具體。為了使用戶、軟件開發(fā)者及分析和測試人員對該軟件的初始規(guī)定有一個共同的理解，它說明了本軟件的各項功能需求、 性能需求和數據需求，明確標識各項功能的具體含義，闡述實用背景及范圍，提供客戶解決問題或達到目標所需要的條件或權能，提供一個度量和遵循的基準。具體而言，編寫軟件需求說明的目的是為所開發(fā)的軟件提出:a)軟件設計總體要求，作為軟件開發(fā)人員、軟件測試人員相互了解的基礎。b)功能、性能要求，數據結構和采集要求，重要的接口要求，作為軟件設計人員進行概要設計的依據。C)軟件確認測試的依據。1.2

3、編寫依據指明該需求規(guī)格說明書的依據。一般可以寫依據XXX軟件的方案書,策劃書等。1.3術語和縮略詞縮寫、術語及符號解釋2軟件概要2.1軟件總體描述從總體上描述該軟件的情況，包括軟件的形式（網站，運行時系統，插件等） 和軟件的主要的功能，使讀者對該軟件有一個整體的認識。一般一兩段話即可。2.2軟件設計約束及有關說明軟件設計的約束以及有關說明如下所示。開發(fā)環(huán)境: 編程語言: 遵循的規(guī)范：軟件的設計和開發(fā)過程需要嚴格按照合同要求，根據軟件 的設計方案來進行。軟件開發(fā)過程應遵循軟件工程規(guī)范，對過程和版本 進行管理和控制。測試環(huán)境：可以寫明在什么單位測試，測試單位使用的軟硬件環(huán)境。軟件交付形式: 軟件交

4、付日期: 其他：見合同。2.3使用者特點指明軟件的使用者具有的特定。示例:本軟件主要在甲方工作環(huán)境中使用， 使用者包括項目管理人員，開發(fā)人員及 工程師等，使用者在計算機的應用、使用上不存在障礙，都在計算機的操作和使 用方面得到過相關的培訓。3開發(fā)和運行環(huán)境3.1硬件環(huán)境XXX軟件的運行環(huán)境為個人計算機。詳細要求見表 3. 1。表3. 1軟件運行環(huán)境硬件要求需求名稱詳細要求CPU內存硬盤3.2支持軟件環(huán)境需求名稱詳細要求操作系統3.3 接口3.3.1外部接口說明軟件運行時和外部環(huán)境的接口，包括軟件的界面表現形式等方面。示例:外部接口的用戶界面部分按Win dows應用軟件用戶界面的規(guī)范來設計，界

5、面設計風格與XXX環(huán)境保持一致，采用XXX以及對話框等方式作為用戶界面, 便于用戶使用。332軟件接口說明軟件與它運行的軟件環(huán)境之間的接口。示例:本軟件運行于XXX軟件及以上版本上，整個環(huán)境需要運行在 Windows某某版本及更高版本并裝有XXX （依賴軟件）的操作系統之上。3.3.3硬件接口指明軟件和運行的硬件環(huán)境的接口。Inter或其他系列的微型計算機，內存 XXXG以上，硬盤XXXG以上。3.3.4 內部接口說明軟件內部各個模塊之間的接口或規(guī)范， 軟件各個模塊間數據交換的格式 等。示例:軟件內部的接口是通過XXX來進行交換的。用戶使用XXX軟件可以說 軟件的各個模塊之間主要通過 XXX來

6、進行關聯，傳送數據并交換信息，從而降低軟件模塊間的耦合程度。3.4控制和操作說明使用軟件時需要進行的控制和操作方式。示例:XXX軟件最終交付形式為XXX。控制該軟件運行的方法為通過鼠標雙擊或命令行啟動XXX環(huán)境，然后通過鼠標啟動XXX。XXX軟件提供XXX等功能，各個功能項的設置及使用應符合人們使用計算機的操作習慣，通過常用的鼠標點擊，鍵盤輸入以及菜單等形式來完成啟動和使 用軟件的過程，控制信號均由鼠標和鍵盤進行輸入。4詳細需求4.1性能需求4.1.1 精度要求要按照嚴格的數據格式輸入，對符合數據格式要求的輸入進行提示。4.1.2時間特性要求軟件啟動時間: 系統實時響應時間：軟件使用過程中，對

7、用戶在各個功能模塊的鼠標點 擊、鍵盤輸入等操作事件的響應時間需在用戶能夠容忍的范圍之內, 般要求小于1秒。數據的轉換和傳送時間：對軟件不同模塊間的數據交互，要求數據的轉 換和傳送時間不得超過 XXX。數據更新時間：XXX 04.1.3靈活性要求XXX軟件能夠支持鼠標、鍵盤等多種操作方式的使用。軟件的設計和實現需要考慮到運行環(huán)境的變化，并能夠在運行環(huán)境變化的情況下正常使用。同時, 軟件需要兼容其他軟件接口的變化，以保證在不同運行環(huán)境，不同軟件接口的情 況下的正常使用。具體要求如下:操作方式上的變化：軟件應支持多種操作方式，例如鼠標、鍵盤和菜單運行環(huán)境的變化：軟件的設計和實現需要考慮其運行環(huán)境的變

8、化，并能對不同的運行環(huán)境提供支持。具體而言，軟件應支持Win dows某某版本及以上版本的操作系統，支持 XXX環(huán)境。同其他軟件接口的變化：當其他軟件的接口發(fā)生變化時，XXX軟件應能夠適應接口的變化。精度和有效時限的變化：靈活性要求軟件能夠方便的適應精度和有效時 限的變化。計劃的變化或改進：軟件應具有足夠的靈活性，以適應將來有可能會出 現的需求更改或增加。4.2功能需求經過多次需求調研，現提出XXX軟件的功能需求。XXX軟件包括XXX、xxx等等模塊，軟件的組織結構圖如圖4. 1所示。此處可以給出軟彳牛的功龍模塊圖圖4. 1XXX軟件研究內容給出整個軟件的用例圖見圖4. 2。XXX整個軟件的用

9、例圉,用rose®.圖4. 2軟件用例圖XXX軟件的主要功能模塊劃分，以及各個模塊主要的功能描述見表4. 1所示。模塊名稱功能描述XXX模塊XXX模塊XXX模塊XXX模塊表4. 1XXX軟件功能模塊軟件XXX模塊XXX模塊F面以分節(jié)的形式，詳細介紹軟件的各個功能模塊，每個功能模塊占一節(jié),如421,422等等。在介紹每個功能模塊時，首先給出該模塊功能的總體描述, 然后給出本模塊的用例圖，然后，在本小節(jié)內部，再往下分一級標題，分不同的 點來介紹本模塊的各個功能。4.3數據需求4.3.1數據采集的要求:輸入源：手工鍵盤輸入;輸入介質和設備：鍵盤，鼠標;4.3.2數據輸出要求:輸出介質和設備

10、：顯示器、文件;5故障處理需求5.1軟件運行故障在使用軟件的過程中，當出現計算機斷電，計算機內存不足等情況時，XXX軟件將出現運行故障。運行故障發(fā)生時，軟件的各個功能模塊將無法正常使用, 啟動相關功能按鈕都無法進行正常的操作。對由于計算機斷電引發(fā)的軟件運行故障， 用戶在重新給計算機供電后，可以 通過重新啟動計算機，并啟動 XXX軟件的方式恢復軟件的正常運行與使用。對由于計算機內存不足引發(fā)的軟件運行故障， 建議暫時關閉軟件。用戶應檢查并解決計算機內存不足的問題，內存使用情況正常后，XXX軟件將恢復正常的運行與使用。出現軟件運行故障并進行修復后，應確保 XXX軟件功能的完整性，不能發(fā)生因軟件運行故

11、障而導致工具無法繼續(xù)使用的情況。5.2軟件使用故障在軟件的使用過程中，如果出現軟件使用故障，應當具有報警信息提示。1）當軟件依賴的文件損毀或丟失時，軟件以對話框的形式進行提示，報告損毀或丟失的文件等相關錯誤，以幫助用戶及時修復軟件的正常功能。2）對軟件需要用戶輸入項的情況，如果發(fā)生缺少輸入項、輸入項格式錯誤或不符合規(guī)則等情況，軟件應以合理的方式予以提示。3）為了防止用戶由于未及時保存而導致信息丟失的情況，軟件提供定時保 存機制，每隔一定時間自動對信息進行保存，從而保證用戶數據的安全。6質量需求1)2)軟件的功能實現必須符合常用的主流 XX軟件的使用方法和操作習慣。XXX工具的需要滿足操作簡單的要求，能夠使用戶沒有障礙的使用該工具進行一系列的開發(fā)工作。3)要求可配置型強，便于使用者對工具的使用以及定制。4)5)采用可行、合理、高效的方式進行開放性的設計和實現。軟件具有很強的適應能力，并且便于維護，不僅能很好的滿足當前的需求，而且應當為后期可能的開發(fā)的工作提供很好的擴展和維護接口。7其他需求7.1易用性需求作為一款XXX, XXX軟件的設計和實現遵循易用性原則，工具的安裝和入門，工具的用戶界面布局，使用工具的操作方式等方面都應符合主流XX軟件