XXX項(xiàng)目軟件設(shè)計(jì)規(guī)格說明書模板

1、附件三XXX項(xiàng)目軟件設(shè)計(jì)規(guī)格說明書版本<1.0>文檔信息項(xiàng)目名稱項(xiàng)目編號文檔名稱設(shè)計(jì)規(guī)格說明書存儲位置版本作者/修改者日期描述2.目錄1概述1.1編寫目的2.1.2編寫依據(jù)2.1.3術(shù)語和縮略詞2.2軟件概要3.2.1軟件總體描述3.2.2軟件設(shè)計(jì)約束及有關(guān)說明.32.3使用者特點(diǎn)3.3開發(fā)和運(yùn)行環(huán)境4.3.1硬件環(huán)境.4.3.2支持軟件環(huán)境4.3.3 接口4.3.4控制和操作5.4詳細(xì)需求6.4.1性能需求6.4.2功能需求7.4.3數(shù)據(jù)需求9.5故障處理需求105.1軟件運(yùn)行故障105.2軟件使用故障106質(zhì)量需求117其他需求127.1易用性需求127.2安全性需求121概述

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

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

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

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

6、 說軟件的各個(gè)模塊之間主要通過 XXX來進(jìn)行關(guān)聯(lián)，傳送數(shù)據(jù)并交換信息，從而 降低軟件模塊間的耦合程度。3.4控制和操作說明使用軟件時(shí)需要進(jìn)行的控制和操作方式。示例:XXX軟件最終交付形式為XXX?？刂圃撥浖\(yùn)行的方法為通過鼠標(biāo)雙擊或 命令行啟動(dòng)XXX環(huán)境，然后通過鼠標(biāo)啟動(dòng) XXX 。XXX軟件提供XXX等功能，各個(gè)功能項(xiàng)的設(shè)置及使用應(yīng)符合人們使用計(jì)算機(jī)的操作習(xí)慣，通過常用的鼠標(biāo)點(diǎn)擊，鍵盤輸入以及菜單等形式來完成啟動(dòng)和使用軟件的過程，控制信號均由鼠標(biāo)和鍵盤進(jìn)行輸入。4詳細(xì)需求4.1性能需求4.1.1 精度要求要按照嚴(yán)格的數(shù)據(jù)格式輸入，對符合數(shù)據(jù)格式要求的輸入進(jìn)行提示。4.1.2時(shí)間特性要求軟件啟

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

8、的變化：軟件的設(shè)計(jì)和實(shí)現(xiàn)需要考慮其運(yùn)行環(huán)境的變化，并能對不同的運(yùn)行環(huán)境提供支持。具體而言，軟件應(yīng)支持 Windows某某版本及以上版本的操作系統(tǒng),支持 XXX環(huán)境。同其他軟件接口的變化:當(dāng)其他軟件的接口發(fā)生變化時(shí)，XXX軟件應(yīng)能夠適應(yīng)接口的變化。精度和有效時(shí)限的變化:靈活性要求軟件能夠方便的適應(yīng)精度和有效時(shí)限的變化。計(jì)劃的變化或改進(jìn)：軟件應(yīng)具有足夠的靈活性，以適應(yīng)將來有可能會出 現(xiàn)的需求更改或增加。4.2功能需求經(jīng)過多次需求調(diào)研，現(xiàn)提出 XXX軟件的功能需求。XXX軟件包括XXX、XXX等等模塊，軟件的組織結(jié)構(gòu)圖如圖 4. 1所示。此處可Ui給出軟彳牛的功能模塊圖圖4. 1XXX軟件研究內(nèi)容給

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

10、：鍵盤，鼠標(biāo);4.3.2數(shù)據(jù)輸出要求:輸出介質(zhì)和設(shè)備：顯示器、文件;5故障處理需求5.1軟件運(yùn)行故障在使用軟件的過程中，當(dāng)出現(xiàn)計(jì)算機(jī)斷電，計(jì)算機(jī)內(nèi)存不足等情況時(shí)，XXX 軟件將出現(xiàn)運(yùn)行故障。運(yùn)行故障發(fā)生時(shí)，軟件的各個(gè)功能模塊將無法正常使用， 啟動(dòng)相關(guān)功能按鈕都無法進(jìn)行正常的操作。對由于計(jì)算機(jī)斷電引發(fā)的軟件運(yùn)行故障， 用戶在重新給計(jì)算機(jī)供電后，可以 通過重新啟動(dòng)計(jì)算機(jī)，并啟動(dòng) XXX軟件的方式恢復(fù)軟件的正常運(yùn)行與使用。對由于計(jì)算機(jī)內(nèi)存不足引發(fā)的軟件運(yùn)行故障， 建議暫時(shí)關(guān)閉軟件。用戶應(yīng)檢查并解決計(jì)算機(jī)內(nèi)存不足的問題，內(nèi)存使用情況正常后，XXX軟件將恢復(fù)正常的運(yùn)行 與使用。出現(xiàn)軟件運(yùn)行故障并進(jìn)行修復(fù)

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