資源描述:
《軟件開發(fā)設(shè)計文檔模板》由會員上傳分享,免費(fèi)在線閱讀,更多相關(guān)內(nèi)容在行業(yè)資料-天天文庫。
1、軟件文檔編寫指南封面格式:文檔編號版本號文檔名稱:項目名稱:項目負(fù)責(zé)人:編寫年月日校對年月日審核年月日批準(zhǔn)年月日開發(fā)單位系統(tǒng)規(guī)約說明書(SystemSpecification)一.引言A.文檔的范圍和目的B.概述1.目標(biāo)2.約束二.功能和數(shù)據(jù)描述A.系統(tǒng)結(jié)構(gòu)1.結(jié)構(gòu)關(guān)系圖2.結(jié)構(gòu)關(guān)系圖描述三.子系統(tǒng)描述A.子系統(tǒng)N的結(jié)構(gòu)圖規(guī)約說明B.結(jié)構(gòu)字典C.結(jié)構(gòu)連接圖和說明四.系統(tǒng)建模和模擬結(jié)構(gòu)A.用于模擬的系統(tǒng)模型A.模擬結(jié)果B.特殊性能一.軟件項目問題A.軟件項目可行性研究報告B.軟件項目計劃二.附錄軟件項目可行性研究報告(Reportfo
2、rFeasibilityStudy)一.引言1.編寫目的(闡明編寫可行性研究報告的目的,指出讀者對象)2.項目背景(應(yīng)包括:(1)所建議開發(fā)的軟件名稱;(2)項目的任務(wù)提出者、開發(fā)者、用戶及實現(xiàn)單位;(3)項目與其他軟件或其他系統(tǒng)的關(guān)系。)3.定義(列出文檔中用到的專門術(shù)語的定義和縮略詞的原文。)4.參考資料(列出有關(guān)資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源。)二.可行性研究的前提1.要求(列出并說明建議開發(fā)軟件的基本要求,如(1)功能;(2)性能;(3)輸出;(4)輸入;(5)基本的數(shù)據(jù)流程和處理流程;(6)安全與保密
3、要求;(7)與軟件相關(guān)的其他系統(tǒng);(8)完成期限。)2.目標(biāo)(可包括:(1)人力與設(shè)備費(fèi)用的節(jié)??;(2)處理速度的提高;(3)控制精度和生產(chǎn)能力的提高;(4)管理信息服務(wù)的改進(jìn);(5)決策系統(tǒng)的改進(jìn);(6)人員工作效率的提高,等等。)3.條件、假定和限制(可包括:(1)建議開發(fā)軟件運(yùn)行的最短壽命;(2)進(jìn)行系統(tǒng)方案選擇比較的期限;(3)經(jīng)費(fèi)來源和使用限制;(4)法律和政策方面的限制;(5)硬件、軟件、運(yùn)行環(huán)境和開發(fā)環(huán)境的條件和限制;(6)可利用的信息和資源;(7)建議開發(fā)軟件投入使用的最遲時間。)4.可行性研究方法5.決定可行性的主
4、要因素三.對現(xiàn)有系統(tǒng)的分析1.處理流程和數(shù)據(jù)流程2.工作負(fù)荷3.費(fèi)用支出(如人力、設(shè)備、空間、支持性服務(wù)、材料等項開支。)4.人員(列出所需人員的專業(yè)技術(shù)類別和數(shù)量。)5.設(shè)備6.局限性(說明現(xiàn)有系統(tǒng)存在的問題以及為什么需要開發(fā)新的系統(tǒng)。)四.所建議技術(shù)可行性分析1.對系統(tǒng)的簡要描述2.處理流程和數(shù)據(jù)流程3.與現(xiàn)有系統(tǒng)比較的優(yōu)越性4.采用建議系統(tǒng)可能帶來的影響(1)對設(shè)備的影響(2)對現(xiàn)有軟件的影響(1)對用戶的影響(2)對系統(tǒng)運(yùn)行的影響(3)對開發(fā)環(huán)境的影響(4)對運(yùn)行環(huán)境的影響(5)對經(jīng)費(fèi)支出的影響1.技術(shù)可行性評價(包括:(1
5、)在限制條件下,功能目標(biāo)是否能夠達(dá)到;(2)利用現(xiàn)有技術(shù),功能目標(biāo)能否達(dá)到;(3)對開發(fā)人員數(shù)量和質(zhì)量的要求,并說明能否滿足;(4)在規(guī)定的期限內(nèi),開發(fā)能否完成。)一.所建議系統(tǒng)經(jīng)濟(jì)可行性分析1.指出(1)基建投資(2)其他一次性支出(3)經(jīng)常性支出2.效益(1)一次性收益(2)經(jīng)常性收益(3)不可定量收益3.收益/投資比4.投資回收周期5.敏感性分析(指一些關(guān)鍵性因素,如:系統(tǒng)生存周期長短、系統(tǒng)工作負(fù)荷量、處理速度要求、設(shè)備和軟件配置變化對支出和效益的影響等的分析。)二.社會因素可行性分析1.法律因素(如,合同責(zé)任、侵犯專利權(quán)、侵
6、犯版權(quán)等問題的分析。)2.用戶使用可行性(如,用戶單位的行政管理、工作制度、人員素質(zhì)等能否滿足要求。)三.其他可供選擇的方案(逐個闡明其他可供選擇的方案,并重點說明未被推薦的理由。)四.結(jié)論意見(可能是:(1)可著手組織開發(fā);(2)需待若干條件(如資金、人力設(shè)備等)具備后才能開發(fā);(3)需對開發(fā)目標(biāo)進(jìn)行某些修改;(4)不能進(jìn)行或不必進(jìn)行(如技術(shù)不成熟,經(jīng)濟(jì)上不合算等);(4)其他。)軟件項目計劃(SoftwareProjectPlan)一.引言1.編寫目的(闡明編寫軟件計劃的目的,指出讀者對象。)2.項目背景(可包括:(1)項目委托
7、單位、開發(fā)單位和主管部門;(2)該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。)3.定義(列出本文檔中用到的專門術(shù)語的定義和縮略詞的原文。)4.參考資料(可包括:(1)項目經(jīng)核準(zhǔn)的計劃任務(wù)書、合同或上級機(jī)關(guān)的批文;(2)文檔所引用的資料、規(guī)范等;列出資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源。)二.項目概述1.工作內(nèi)容(簡要說明項目的各項主要工作,介紹所開發(fā)軟件的功能性能等.若不編寫可行性研究報告,則應(yīng)在本節(jié)給出較詳細(xì)的介紹。)1.條件與限制(闡明為完成項目應(yīng)具備的條件開發(fā)單位已具備的條件以及尚需創(chuàng)造的條件.必要時還應(yīng)說明用戶及分合同承包者
8、承擔(dān)的工作完成期限及其它條件與限制。)2.產(chǎn)品(1)程序(列出應(yīng)交付的程序名稱使用的語言及存儲形式。)(2)文檔(列出應(yīng)交付的文檔。)(3)運(yùn)行環(huán)境(應(yīng)包括硬件環(huán)境軟件環(huán)境。)4.服務(wù)(闡明開發(fā)單位可向用戶提供的服務(wù).如人員培訓(xùn)安裝保