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

1、附件三XXX項(xiàng)目 軟件設(shè)計(jì)規(guī)格說(shuō)明書(shū) 版本 <>文檔信息項(xiàng)目名稱項(xiàng)目編號(hào)文檔名稱設(shè)計(jì)規(guī)格說(shuō)明書(shū)存儲(chǔ)位置版本作者 / 修改者日期描述目錄1 概述 錯(cuò)誤 !未定義書(shū)簽。 編寫(xiě)目的 錯(cuò)誤 !未定義書(shū)簽。 編寫(xiě)依據(jù) 錯(cuò)誤 !未定義書(shū)簽。 術(shù)語(yǔ)和縮略詞 錯(cuò)誤 ! 未定義書(shū)簽。2 軟件概要 錯(cuò)誤 !未定義書(shū)簽。 軟件總體描述 錯(cuò)誤 ! 未定義書(shū)簽。 軟件設(shè)計(jì)約束及有關(guān)說(shuō)明錯(cuò)誤 !未定義書(shū)簽。使用者特點(diǎn) 錯(cuò)誤 !未定義書(shū)簽。3 開(kāi)發(fā)和運(yùn)行環(huán)境 錯(cuò)誤 ! 未定義書(shū)簽。硬件環(huán)境 錯(cuò)誤 !未定義書(shū)簽。 支持軟件環(huán)境 錯(cuò)誤 ! 未定義書(shū)簽。 接口 錯(cuò)誤 !未定義書(shū)簽。控制和操作 錯(cuò)誤 !未定義書(shū)簽。4

2、詳細(xì)需求 錯(cuò)誤!未定義書(shū)簽。 性能需求 錯(cuò)誤 ! 未定義書(shū)簽。 功能需求 錯(cuò)誤 ! 未定義書(shū)簽。 數(shù)據(jù)需求 錯(cuò)誤 !未定義書(shū)簽。5 故障處理需求 錯(cuò)誤 ! 未定義書(shū)簽。 軟件運(yùn)行故障 錯(cuò)誤 ! 未定義書(shū)簽。 軟件使用故障 錯(cuò)誤 ! 未定義書(shū)簽。6 質(zhì)量需求 錯(cuò)誤!未定義書(shū)簽。7 其他需求 錯(cuò)誤 !未定義書(shū)簽。 易用性需求 錯(cuò)誤 !未定義書(shū)簽。 安全性需求 錯(cuò)誤 !未定義書(shū)簽。1 概述 編寫(xiě)目的 指出編寫(xiě)需求規(guī)格說(shuō)明書(shū)的目的。下面是示例： 編寫(xiě)此文檔的目的是進(jìn)一步定制軟件開(kāi)發(fā)的細(xì)節(jié)問(wèn)題， 希望能使本軟件開(kāi)發(fā)工作更具體。 為了使 用戶、 軟件開(kāi)發(fā)者及分析和測(cè)試人員對(duì)該軟件的初始規(guī)定有一個(gè)共同的理解

3、，它說(shuō)明了本軟件的各項(xiàng)功能需求、性能需求和數(shù)據(jù)需求， 明確標(biāo)識(shí)各項(xiàng)功能的具體含義， 闡述實(shí)用背景及范圍， 提 供客戶解決問(wèn)題或達(dá)到目標(biāo)所需要的條件或權(quán)能， 提供一個(gè)度量和遵循的基準(zhǔn)。 具體而言， 編寫(xiě) 軟件需求說(shuō)明的目的是為所開(kāi)發(fā)的軟件提出： 軟件設(shè)計(jì)總體要求，作為軟件開(kāi)發(fā)人員、軟件測(cè)試人員相互了解的基礎(chǔ)。功能、性能要求，數(shù)據(jù)結(jié)構(gòu)和采集要求，重要的接口要求， 作為軟件設(shè)計(jì)人員進(jìn)行概要設(shè)計(jì)的依 據(jù)。軟件確認(rèn)測(cè)試的依據(jù)。編寫(xiě)依據(jù) 指明該需求規(guī)格說(shuō)明書(shū)的依據(jù)。一般可以寫(xiě)依據(jù)XXX 軟件的方案書(shū)，策劃書(shū)等。術(shù)語(yǔ)和縮略詞縮寫(xiě)、術(shù)語(yǔ)及符號(hào)解釋2 軟件概要軟件總體描述 從總體上描述該軟件的情況，包括軟件的形

4、式（網(wǎng)站，運(yùn)行時(shí)系統(tǒng)，插件等）和軟件的主要的功 能，使讀者對(duì)該軟件有一個(gè)整體的認(rèn)識(shí)。一般一兩段話即可。軟件設(shè)計(jì)約束及有關(guān)說(shuō)明 軟件設(shè)計(jì)的約束以及有關(guān)說(shuō)明如下所示。開(kāi)發(fā)環(huán)境：編程語(yǔ)言：遵循的規(guī)范： 軟件的設(shè)計(jì)和開(kāi)發(fā)過(guò)程需要嚴(yán)格按照合同要求， 根據(jù)軟件的設(shè)計(jì)方案來(lái)進(jìn)行。 軟件 開(kāi)發(fā)過(guò)程應(yīng)遵循軟件工程規(guī)范，對(duì)過(guò)程和版本進(jìn)行管理和控制。測(cè)試環(huán)境：可以寫(xiě)明在什么單位測(cè)試，測(cè)試單位使用的軟硬件環(huán)境。軟件交付形式：軟件交付日期：其他：見(jiàn)合同。使用者特點(diǎn)指明軟件的使用者具有的特定。示例：本軟件主要在甲方工作環(huán)境中使用， 使用者包括項(xiàng)目管理人員， 開(kāi)發(fā)人員及工程師等， 使用者在 計(jì)算機(jī)的應(yīng)用、使用上不存在障礙，

5、都在計(jì)算機(jī)的操作和使用方面得到過(guò)相關(guān)的培訓(xùn)。3 開(kāi)發(fā)和運(yùn)行環(huán)境硬件環(huán)境XXX軟件的運(yùn)行環(huán)境為個(gè)人計(jì)算機(jī)。詳細(xì)要求見(jiàn)錯(cuò)誤 !未找到引用源。表 3. 1 軟件運(yùn)行環(huán)境硬件要求需求名稱詳細(xì)要求CPU內(nèi)存硬盤(pán)支持軟件環(huán)境需求名稱詳細(xì)要求操作系統(tǒng)接口外部接口 說(shuō)明軟件運(yùn)行時(shí)和外部環(huán)境的接口，包括軟件的界面表現(xiàn)形式等方面。示例： 外部接口的用戶界面部分按 Windows 應(yīng)用軟件用戶界面的規(guī)范來(lái)設(shè)計(jì)，界面設(shè)計(jì)風(fēng)格與XXX 環(huán)境保持一致，采用 XXX以及對(duì)話框等方式作為用戶界面，便于用戶使用。軟件接口 說(shuō)明軟件與它運(yùn)行的軟件環(huán)境之間的接口。示例： 本軟件運(yùn)行于 XXX 軟件及以上版本上，整個(gè)環(huán)境需要運(yùn)行在

6、Windows 某某版本及更高版本并裝 有 XXX（依賴軟件）的操作系統(tǒng)之上。硬件接口 指明軟件和運(yùn)行的硬件環(huán)境的接口。Inter 或其他系列的微型計(jì)算機(jī)，內(nèi)存XXXG 以上，硬盤(pán) XXXG以上。內(nèi)部接口說(shuō)明軟件內(nèi)部各個(gè)模塊之間的接口或規(guī)范，軟件各個(gè)模塊間數(shù)據(jù)交換的格式等。示例： 軟件內(nèi)部的接口是通過(guò) XXX來(lái)進(jìn)行交換的。用戶使用 XXX軟件 可以說(shuō)軟件的各個(gè)模塊之間主 要通過(guò) XXX來(lái)進(jìn)行關(guān)聯(lián)，傳送數(shù)據(jù)并交換信息，從而降低軟件模塊間的耦合程度?？刂坪筒僮?說(shuō)明使用軟件時(shí)需要進(jìn)行的控制和操作方式。示例：XXX軟件最終交付形式為 XXX?？刂圃撥浖\(yùn)行的方法為通過(guò)鼠標(biāo)雙擊或命令行啟動(dòng) XXX環(huán)境

7、， 然后通過(guò)鼠標(biāo)啟動(dòng) XXX。XXX軟件提供 XXX 等功能， 各個(gè)功能項(xiàng)的設(shè)置及使用應(yīng)符合人們使用計(jì)算機(jī)的操作習(xí)慣， 通過(guò)常 用的鼠標(biāo)點(diǎn)擊， 鍵盤(pán)輸入以及菜單等形式來(lái)完成啟動(dòng)和使用軟件的過(guò)程， 控制信號(hào)均由鼠標(biāo)和鍵 盤(pán)進(jìn)行輸入。4 詳細(xì)需求性能需求精度要求要按照嚴(yán)格的數(shù)據(jù)格式輸入，對(duì)符合數(shù)據(jù)格式要求的輸入進(jìn)行提示。時(shí)間特性要求軟件啟動(dòng)時(shí)間：系統(tǒng)實(shí)時(shí)響應(yīng)時(shí)間： 軟件使用過(guò)程中， 對(duì)用戶在各個(gè)功能模塊的鼠標(biāo)點(diǎn)擊、 鍵盤(pán)輸入等操作事件 的響應(yīng)時(shí)間需在用戶能夠容忍的范圍之內(nèi)，一般要求小于 1 秒。數(shù)據(jù)的轉(zhuǎn)換和傳送時(shí)間：對(duì)軟件不同模塊間的數(shù)據(jù)交互，要求數(shù)據(jù)的轉(zhuǎn)換和傳送時(shí)間不得超過(guò)XXX。數(shù)據(jù)更新時(shí)間：

8、 XXX。靈活性要求XXX軟件能夠支持鼠標(biāo)、 鍵盤(pán)等多種操作方式的使用。 軟件的設(shè)計(jì)和實(shí)現(xiàn)需要考慮到運(yùn)行環(huán)境的 變化，并能夠在運(yùn)行環(huán)境變化的情況下正常使用。同時(shí)， 軟件需要兼容其他軟件接口的變化， 以 保證在不同運(yùn)行環(huán)境，不同軟件接口的情況下的正常使用。具體要求如下： 操作方式上的變化：軟件應(yīng)支持多種操作方式，例如鼠標(biāo)、鍵盤(pán)和菜單等。運(yùn)行環(huán)境的變化： 軟件的設(shè)計(jì)和實(shí)現(xiàn)需要考慮其運(yùn)行環(huán)境的變化， 并能對(duì)不同的運(yùn)行環(huán)境提供支 持。具體而言，軟件應(yīng)支持 Windows 某某版本及以上版本的操作系統(tǒng)，支持 XXX環(huán)境。 同其他軟件接口的變化：當(dāng)其他軟件的接口發(fā)生變化時(shí)， XXX軟件應(yīng)能夠適應(yīng)接口的變化

9、。 精度和有效時(shí)限的變化：靈活性要求軟件能夠方便的適應(yīng)精度和有效時(shí)限的變化。 計(jì)劃的變化或改進(jìn)：軟件應(yīng)具有足夠的靈活性，以適應(yīng)將來(lái)有可能會(huì)出現(xiàn)的需求更改或增加。功能需求經(jīng)過(guò)多次需求調(diào)研，現(xiàn)提出 XXX 軟件的功能需求。 XXX軟件包括 XXX、 XXX 等等模塊，軟件的組 織結(jié)構(gòu)圖如 錯(cuò)誤 !未找到引用源。 所示。圖 4. 1XXX 軟件研究?jī)?nèi)容 給出整個(gè)軟件的用例圖見(jiàn) 錯(cuò)誤 !未找到引用源。圖 4. 2 軟件用例圖XXX軟件的主要功能模塊劃分，以及各個(gè)模塊主要的功能描述見(jiàn)錯(cuò)誤 !未找到引用源。 所示。表 4. 1XXX 軟件功能模塊XXX 軟件模塊名稱功能描述XXX模塊XXX模塊XXX模塊X

10、XX模塊XXX模塊XXX模塊下面以分節(jié)的形式，詳細(xì)介紹軟件的各個(gè)功能模塊，每個(gè)功能模塊占一節(jié)，如等等。 在介紹每個(gè) 功能模塊時(shí)， 首先給出該模塊功能的總體描述， 然后給出本模塊的用例圖， 然后， 在本小節(jié)內(nèi)部， 再往下分一級(jí)標(biāo)題，分不同的點(diǎn)來(lái)介紹本模塊的各個(gè)功能。數(shù)據(jù)需求數(shù)據(jù)采集的要求：輸入源：手工鍵盤(pán)輸入； 輸入介質(zhì)和設(shè)備：鍵盤(pán)，鼠標(biāo)； 數(shù)據(jù)輸出要求：輸出介質(zhì)和設(shè)備：顯示器、文件；5 故障處理需求軟件運(yùn)行故障在使用軟件的過(guò)程中， 當(dāng)出現(xiàn)計(jì)算機(jī)斷電， 計(jì)算機(jī)內(nèi)存不足等情況時(shí)， XXX軟件將出現(xiàn)運(yùn)行故障。 運(yùn)行故障發(fā)生時(shí)， 軟件的各個(gè)功能模塊將無(wú)法正常使用， 啟動(dòng)相關(guān)功能按鈕都無(wú)法進(jìn)行正常的操

11、作。對(duì)由于計(jì)算機(jī)斷電引發(fā)的軟件運(yùn)行故障， 用戶在重新給計(jì)算機(jī)供電后， 可以通過(guò)重新啟動(dòng)計(jì)算機(jī)， 并啟動(dòng) XXX 軟件的方式恢復(fù)軟件的正常運(yùn)行與使用。對(duì)由于計(jì)算機(jī)內(nèi)存不足引發(fā)的軟件運(yùn)行故 障，建議暫時(shí)關(guān)閉軟件。用戶應(yīng)檢查并解決計(jì)算機(jī)內(nèi)存不足的問(wèn)題，內(nèi)存使用情況正常后， XXX 軟件將恢復(fù)正常的運(yùn)行與使用。出現(xiàn)軟件運(yùn)行故障并進(jìn)行修復(fù)后，應(yīng)確保 XXX 軟件功能的完整性，不能發(fā)生因軟件運(yùn)行故障而 導(dǎo)致工具無(wú)法繼續(xù)使用的情況。軟件使用故障 在軟件的使用過(guò)程中，如果出現(xiàn)軟件使用故障，應(yīng)當(dāng)具有報(bào)警信息提示。 當(dāng)軟件依賴的文件損毀或丟失時(shí)， 軟件以對(duì)話框的形式進(jìn)行提示， 報(bào)告損毀或丟失的文件等相關(guān) 錯(cuò)誤，以

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