版權(quán)說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請(qǐng)進(jìn)行舉報(bào)或認(rèn)領(lǐng)
文檔簡介
令狐采學(xué)創(chuàng)作令狐采學(xué)創(chuàng)作計(jì)算機(jī)軟件產(chǎn)品開發(fā)文件編制指南 GB8567-88
Guidelinesforcomputersoftwareproductdevelopmentdocumentation
令狐采學(xué)中華人民共和國國家標(biāo)準(zhǔn)
UDC681.3引言1目的
一項(xiàng)計(jì)算機(jī)軟件的籌劃、研制及實(shí)現(xiàn),構(gòu)成一個(gè)軟件開發(fā)項(xiàng)目。一個(gè)軟件開發(fā)項(xiàng)目的進(jìn)行,一般需要在人力和自動(dòng)化資源等方面作重大的投資。為了保證項(xiàng)目開發(fā)的成功,最經(jīng)濟(jì)地花費(fèi)這些投資,并且便于運(yùn)行和維護(hù),在開發(fā)工作的每一階段,都需要編制二定的文件。這些文件連同計(jì)算機(jī)程序及數(shù)據(jù)一起,構(gòu)成為計(jì)算機(jī)軟件。文件是計(jì)算機(jī)軟件中不可缺少的組成部分,它的作用是:
a.作為開發(fā)人員在一定階段內(nèi)的工作成果和結(jié)束標(biāo)志;
b.向管理人員提供軟件開發(fā)過程中的進(jìn)展和情況,把軟件開發(fā)過程中的一些“不可見的”事物轉(zhuǎn)換成“可見的”文字資料。以便管理人員在各個(gè)階段檢查開發(fā)計(jì)劃的實(shí)施進(jìn)展,使之能夠判斷原定目標(biāo)是否已達(dá)到,還將繼續(xù)耗用資源的種類和數(shù)量;
C.記錄開發(fā)過程中的技術(shù)信息,便于協(xié)調(diào)以后的軟件開發(fā)、使用和修改;
d.提供對(duì)軟件的有關(guān)運(yùn)行、維護(hù)和培訓(xùn)的信息,便于管理人員、開發(fā)人員、操作人員和用戶之間相互了解彼此的工作;
e.向潛在用戶報(bào)導(dǎo)軟件的功能和性能,使他們能判定該軟件能否服務(wù)于自己的需要。
換言之,本指南認(rèn)為:文件的編制必須適應(yīng)計(jì)算機(jī)軟件整個(gè)生存周期的需要。
計(jì)算機(jī)軟件所包含的文件有兩類:一類是開發(fā)過程中填寫的各種圖表,可稱之為工作表格;另一類則是應(yīng)編制的技術(shù)資料或技術(shù)管理資料,可稱之為文件。本指南規(guī)定軟件文件的編制形式,并提供對(duì)這些規(guī)定的解釋。本指南的目的是使得所編制的軟件文件確實(shí)能夠起到軟件文件應(yīng)該發(fā)揮的作用。2范圍
本指南是一份指導(dǎo)性文件。本指甫建議,在一項(xiàng)計(jì)算機(jī)軟件的開發(fā)過程中,一般地說,應(yīng)該產(chǎn)生十四種文件。這十四種文件是:
可行性研究報(bào)告;
項(xiàng)目開發(fā)計(jì)劃;
軟件需求說明書;
數(shù)據(jù)要求說明書;
概要設(shè)計(jì)說明書;
詳細(xì)設(shè)計(jì)說明書;
數(shù)據(jù)庫設(shè)計(jì)說明書;
用戶手冊;
操作手冊;
模塊開發(fā)卷宗;
測試計(jì)劃;
測試分析報(bào)告;
開發(fā)進(jìn)度月報(bào);
項(xiàng)目開發(fā)總結(jié)報(bào)告。
本指南將給出開發(fā)過程中建議產(chǎn)生的這十四種文件的編制指導(dǎo),同時(shí),本指南也是這十四種文件的編寫質(zhì)量的檢驗(yàn)準(zhǔn)則。但是,本指南并未涉及軟件開發(fā)過程中如何填寫工作表格的問題。
一般地說,一個(gè)軟件總是一個(gè)計(jì)算機(jī)系統(tǒng)(包括硬件、固件和軟件)的組成部分。鑒于計(jì)算機(jī)系統(tǒng)的多樣性,本指南一般不涉及整個(gè)系統(tǒng)開發(fā)中的文件編制問題,本指南僅僅是軟件開發(fā)過程中的文件編制指南。
3文件的使用者
對(duì)于使用文件的人員而言,他們所關(guān)心的文件的種類,隨他們所承擔(dān)的工作而異。
管理人員:可行性研究報(bào)告,
項(xiàng)目開發(fā)計(jì)劃,
模塊開發(fā)卷宗,
開發(fā)進(jìn)度月報(bào),
項(xiàng)目開發(fā)總結(jié)報(bào)告;
開發(fā)人員:可行性研究報(bào)告,
項(xiàng)目開發(fā)計(jì)劃,
軟件需求說明書,
數(shù)據(jù)要求說明書,
概要設(shè)計(jì)說明書,
詳細(xì)設(shè)計(jì)說明書,
數(shù)據(jù)庫設(shè)計(jì)說明書,
測試計(jì)劃,
測試分析報(bào)告;
維護(hù)人員:設(shè)計(jì)說明書,
測試分析報(bào)告,
模塊開發(fā)卷宗;
用戶:用戶手冊,
操作手冊。
盡管本指南提出了在軟件開發(fā)中文件編制的要求,但并不意味著這些文件都必須交給用戶。一項(xiàng)軟件的用戶應(yīng)該得到的文件的種類由供應(yīng)者與用戶之間簽訂的合同規(guī)定。文件的編制指導(dǎo)4軟件生存周期與各種文件的編制
一項(xiàng)計(jì)算機(jī)軟件,從出現(xiàn)一個(gè)構(gòu)思之日起,經(jīng)過這項(xiàng)軟件開發(fā)成功投入使用,直到最后決定停止使用,并被另一一項(xiàng)軟件代替之時(shí)止,被認(rèn)為是該軟件的一個(gè)生存周期。一般地說這個(gè)軟件生存周期可以分成以下六個(gè)階段:可行性與計(jì)劃研究階段
需求分析階段
設(shè)計(jì)階段
實(shí)現(xiàn)階段
測試階段
運(yùn)行與維護(hù)階段
在可行性研究與計(jì)劃階段內(nèi),要確定該軟件的開發(fā)目標(biāo)和總的要求,要進(jìn)行可行性分析、投資一收益分析、制訂開發(fā)計(jì)劃,并完成應(yīng)編制的文件。
在需求分析階段內(nèi),由系統(tǒng)分析人員對(duì)被設(shè)計(jì)的系統(tǒng)進(jìn)行系統(tǒng)分析,確定對(duì)該軟件的各項(xiàng)功能、性能需求和設(shè)計(jì)約束,確定對(duì)文件編制的要求,作為本階段工作的結(jié)果,一般地說,軟件需求說明書、數(shù)據(jù)要求說明書和初步的用戶手冊應(yīng)該編寫出來。
在設(shè)計(jì)階段內(nèi),系統(tǒng)設(shè)計(jì)人員和程序設(shè)計(jì)人員應(yīng)該在反復(fù)理解軟件需求的基礎(chǔ)上,提出多個(gè)設(shè)計(jì),分析每個(gè)設(shè)計(jì)能履行的功能并進(jìn)行相互比較,最后確定一個(gè)設(shè)計(jì),包括該軟件的結(jié)構(gòu)、模塊的劃分、功能的分配以及處理流程。在被設(shè)計(jì)系統(tǒng)比較復(fù)雜的情況下,設(shè)計(jì)階段應(yīng)分解成概要設(shè)計(jì)階段和詳細(xì)設(shè)計(jì)階段兩個(gè)步驟。在一般情況下,應(yīng)完成的文件包括:概要設(shè)計(jì)說明書、詳細(xì)設(shè)計(jì)說明書和測試計(jì)劃初稿。
在實(shí)現(xiàn)階段內(nèi),要完成源程序的編碼、編譯(或匯編)和排錯(cuò)調(diào)試得到無語法錯(cuò)的程序清單,要開始編寫模塊開發(fā)卷宗,并且要完成用戶手冊、操作手冊等面向用戶的文件的編寫工作,還要完成測試計(jì)劃的編制。
在測試階段,該程序?qū)⒈蝗娴販y試,已編制的文件將被檢查審閱。一般要完成模塊開發(fā)卷宗和測試分析報(bào)告,作為開發(fā)工作的結(jié)束,所生產(chǎn)的程序、文件以及開發(fā)工作本身將逐項(xiàng)被評(píng)價(jià),最后寫出項(xiàng)目開發(fā)總結(jié)報(bào)告。
在整個(gè)開發(fā)過程中(即前五個(gè)階段中),開發(fā)集體要按月編寫開發(fā)進(jìn)度月報(bào)。
在運(yùn)行和維護(hù)階段,軟件將在運(yùn)行使用中不斷地被維護(hù),根據(jù)新提出的需求進(jìn)行必要而且可能的擴(kuò)充和刪改。
對(duì)于一項(xiàng)軟件而言,其生存周期各階段與各種文件編寫工作的關(guān)系可見表互,其中有些文件的編寫工作可能要在若干個(gè)階段中延續(xù)進(jìn)行。
表1軟件生存周期各階段中的文件編制5文件編制中的考慮因素
文件編制是一個(gè)不斷努力的工作過程。是一個(gè)從形成最初輪廓,經(jīng)反復(fù)檢查和修改,直到程序和文件正式交付使用的完整過程。其中每一步都要求工作人員做出很大努力。要保證文件編制的質(zhì)量,要體現(xiàn)每個(gè)開發(fā)項(xiàng)目的特點(diǎn),也要注意不要花太多的人力。為此,編制中要考慮如下各項(xiàng)因素。5.1文件的讀者
每一種文件都具有特定的讀者。這些讀者包括個(gè)人或小組、軟件開發(fā)單位的成員或社會(huì)上的公眾、從事軟件工作的技術(shù)人員、管理人員或領(lǐng)導(dǎo)干部。他們期待著使用這些文件的內(nèi)容來進(jìn)行工作,例如設(shè)計(jì)、編寫程序、測試、使用、維護(hù)或進(jìn)行計(jì)劃管理。因此,這些文件的作者必須了解自己的讀者,這些文件的編寫必須注意適應(yīng)自己的特定讀者的水平、特點(diǎn)和要求。5.2重復(fù)性
本指南第二篇中將列出的這十四種文件的內(nèi)容要求中,顯然存在某些重復(fù)。較明顯的重復(fù)有兩類。引言是每一種文件都要包含的內(nèi)容,以向讀者提供總的梗概。第二類明顯的重復(fù)是各種文件中的說明部分,如對(duì)功能性能的說明、對(duì)輸入和輸出的描述、系統(tǒng)中包含的設(shè)備等。這是為了方便每種文件各自的讀者,每種產(chǎn)品文件應(yīng)該自成體系,盡量避免讀一種文件時(shí)又不得不去參考另一種文件。當(dāng)然,在每一種文件里,有關(guān)引言、說明等同其他文件相重復(fù)的部分,在行文上、在所用的術(shù)語上、在詳細(xì)的程度上,還是應(yīng)該有一些差別,以適應(yīng)各種文件的不同讀者的需要。5.3靈活性
鑒于軟件開發(fā)是具有創(chuàng)造性的腦力勞動(dòng),也鑒于不同軟件在規(guī)模上和復(fù)雜程度上差別極大,本指南認(rèn)為在文件編制工作中應(yīng)允許一定的靈活性。這種靈活性表現(xiàn)在如下各款。
5.3.1應(yīng)編制的文件種類
盡管本指南認(rèn)為在一般情況下,一項(xiàng)軟件的開發(fā)過程中,應(yīng)產(chǎn)生的文件有十四種,然而針對(duì)一項(xiàng)具體的軟件開發(fā)項(xiàng)目,有時(shí)不必編制這么多的文件,可以把幾種文件合并成一種。一般地說,當(dāng)項(xiàng)目的規(guī)模、復(fù)雜性和成敗風(fēng)險(xiǎn)增大時(shí),文件編制的范圍、管理手續(xù)和詳細(xì)程度將隨之增加。反之,則可適當(dāng)減少。為了恰當(dāng)?shù)卣莆者@種靈活性,本指南要求貫徹分工負(fù)責(zé)的原則,這意味著:
a:一個(gè)軟件開發(fā)單位的領(lǐng)導(dǎo)機(jī)構(gòu)應(yīng)該根據(jù)本單位經(jīng)營承包的應(yīng)用軟件的專業(yè)領(lǐng)域和本單位的管理能力,制定一個(gè)對(duì)文件編制要求的實(shí)施規(guī)定,主要是:在不同的條件下,應(yīng)該形成哪些文件?這些文件的詳細(xì)程度?該開發(fā)單位的每一個(gè)項(xiàng)目負(fù)責(zé)人,必須認(rèn)真執(zhí)行這個(gè)實(shí)施規(guī)定。這種規(guī)定的兩個(gè)例子可嘆本指南的附錄o(參考件);
b.對(duì)于一個(gè)具體的應(yīng)用軟件項(xiàng)目,項(xiàng)目負(fù)責(zé)人應(yīng)根據(jù)上述實(shí)施規(guī)定,確定一個(gè)文件編制計(jì)劃,主中包括:
(1)應(yīng)該編制哪幾種文件,詳細(xì)程度如何?
(2)各個(gè)文件的編制負(fù)責(zé)人和進(jìn)度要求;
(3)審查、批準(zhǔn)的負(fù)責(zé)人和時(shí)間進(jìn)度安排;
(4)在開發(fā)時(shí)期內(nèi),各文件的維護(hù)、修改和管理的負(fù)責(zé)人,以及批準(zhǔn)手續(xù)。
每項(xiàng)工作必須落實(shí)到人。
這個(gè)文件編制計(jì)劃是整個(gè)開發(fā)計(jì)劃的重要組成部分;
C.有關(guān)的設(shè)計(jì)人員則必須嚴(yán)格執(zhí)行這個(gè)文件編制計(jì)劃。5.3.2文件的詳細(xì)程度
從同一份提綱起草的文件的篇幅大小往往不同,可以少到幾頁,也可以長達(dá)幾百頁。對(duì)于這種差別本指南是允許的。此詳細(xì)程度取決于任務(wù)的規(guī)模、復(fù)雜性和項(xiàng)目負(fù)責(zé)人對(duì)該軟件的開發(fā)過程及運(yùn)行環(huán)與所需要的詳細(xì)程度的判斷。5.3.3文件的擴(kuò)展
當(dāng)被開發(fā)系統(tǒng)的規(guī)模非常大(例如源碼超過一百萬行)時(shí),一種文件可以分成幾卷編寫,可以按其。每一個(gè)系統(tǒng)分別編制,也可以按內(nèi)容劃分成多卷,例如:
項(xiàng)目開發(fā)計(jì)劃可能包括:質(zhì)量保證計(jì)劃,
配置管理計(jì)劃,
用戶培訓(xùn)計(jì)劃,
安裝實(shí)施計(jì)劃;
系統(tǒng)設(shè)計(jì)說明書可分寫成:系統(tǒng)設(shè)計(jì)說明書,
子系統(tǒng)設(shè)計(jì)說明書;
程序設(shè)計(jì)說明書可分寫成:程序設(shè)計(jì)說明書,
接口設(shè)計(jì)說明書,
版本說明;
操作手冊可分寫成:操作手冊,
安裝實(shí)施過程;
.測試計(jì)劃可分寫成:測試計(jì)劃,
測試設(shè)計(jì)說明,
測試規(guī)程,
測試用例;
測試分析報(bào)告可分寫成:綜合測試報(bào)告,
驗(yàn)收測試報(bào)告;
項(xiàng)目開發(fā)總結(jié)報(bào)告亦可分寫成項(xiàng)目開發(fā)總結(jié)報(bào)告和資源環(huán)境統(tǒng)計(jì)。5.3.4節(jié)的擴(kuò)張與縮并
在有些文件中,可以使用本指南所提供的章、條標(biāo)題,但在條內(nèi)又存在一系列需要分別討論的因素本指南認(rèn)為,所有的條都可以擴(kuò)展,可以進(jìn)一步細(xì)分,以適應(yīng)實(shí)際需要。反之,如果章條中的有些細(xì)節(jié);非必需,也可以根據(jù)實(shí)際情況縮并。此時(shí)章條的編號(hào)應(yīng)相應(yīng)地改變。5.3.5程序設(shè)計(jì)的表現(xiàn)形式
本指南對(duì)于程序的設(shè)計(jì)表現(xiàn)形式并未作出規(guī)定或限制,可以使用流程圖的形式、判定表的形式,1可以使用其他表現(xiàn)形式,如程序設(shè)計(jì)語言(PDL)、問題分析圖(PAD)等。5.3.6文件的表現(xiàn)形式
本指南對(duì)于文件的表現(xiàn)形式亦未作出規(guī)定或限制,可以使用自然語言,也可以使用形式化語言。5.3.7文件的其他種類
當(dāng)本指南中規(guī)定的文件種類尚不能滿足某些應(yīng)用部門的特殊需要時(shí),他們可以建立一些特殊的文件種類要求,例如軟件質(zhì)量保證計(jì)劃、軟件配置管理計(jì)劃等,這些要求可以包含在本單位的文件編制實(shí)施規(guī)定中。6文件編制的管理工作
文件編制工作必須有管理工作的配合,才能使所編制的文件真正發(fā)揮它的作用。文件的編制工作實(shí)際上貫穿于一項(xiàng)軟件的整個(gè)開發(fā)過程,因此,對(duì)文件的管理必須貫穿于整個(gè)開發(fā)過程。在開發(fā)過程中必須進(jìn)行的管理工作是以下四條。
6.1文件的形成
開發(fā)集體中的每個(gè)成員,尤其是項(xiàng)目負(fù)責(zé)人,應(yīng)該認(rèn)識(shí)到:文件是軟件產(chǎn)品的必不可少的組成部分;在軟件開發(fā)過程的各個(gè)階段中,必須按照規(guī)定及時(shí)地完成各種產(chǎn)品文件的編寫工作;必須把在一個(gè)開發(fā)步驟中作出的決定和取得的結(jié)果及時(shí)地寫入文件;開發(fā)集體必須及時(shí)地對(duì)這些文件進(jìn)行嚴(yán)格的評(píng)審;這些文件的形成是各個(gè)階段開發(fā)工作正式完成的標(biāo)志。這些文件上必須有編寫者、評(píng)審者和批準(zhǔn)者的簽字,必須有編寫、評(píng)審?fù)瓿傻娜掌诤团鷾?zhǔn)的日期。
6.2文件的分類與標(biāo)識(shí)
在軟件開發(fā)的過程中,產(chǎn)生的文件是很多的,為了便于保存、查找、使用和修改,應(yīng)該對(duì)文件按層次地加以分類組織。一個(gè)軟件開發(fā)單位應(yīng)該建立一個(gè)對(duì)本單位文件的標(biāo)識(shí)方法,使文件的每一頁都具有明確的標(biāo)識(shí)。例如可以按如下四個(gè)層次對(duì)文件加以分類和標(biāo)識(shí)。
a.文件所屬的項(xiàng)目的標(biāo)識(shí);
b.文件種類的標(biāo)識(shí);
C.同一種文件的不同版本號(hào);
d.頁號(hào)。
此外,對(duì)每種文件還應(yīng)根據(jù)項(xiàng)目的性質(zhì),劃定它們各自的保密級(jí)別,確定他們各自的發(fā)行范圍。
6.3文件的控制
在一項(xiàng)軟件的開發(fā)過程中,隨著程序的逐步形成和逐步修改,各種文件亦在不斷地產(chǎn)生、不斷地修改或補(bǔ)充。因此,必須加以周密的控制,以保持文件與程序產(chǎn)品的一致性,保持各種文件之間的一致性和文件的安全性。這種控制表現(xiàn)為:
a.就從事一項(xiàng)軟件開發(fā)工作的開發(fā)集體而言,應(yīng)設(shè)置一位專職的文件管理人員(接口管理工程師或文件管理員);在開發(fā)集體中,應(yīng)該集中保管本項(xiàng)目現(xiàn)有全部文件的主文本兩套,由該文件管理人員負(fù)責(zé)保管;
b.每一份提交給文件管理人員的文件都必須具有編寫人、審核人和批準(zhǔn)人的簽字;
C.這兩套主文本的內(nèi)容必須完全一致;其中有一套是可供出借的,另一套是絕對(duì)不能出借的,以免發(fā)生萬一;可出借的主文本在出借時(shí)必須辦理出借手續(xù),歸還時(shí)辦理注銷出借手續(xù);
d.開發(fā)集體中的工作人員可以根據(jù)工作的需要,在本項(xiàng)目的開發(fā)過程中持有一些文件,即所謂個(gè)人文件,包括為使他完成他承擔(dān)的任務(wù)所需要的文件,以及他在完成任務(wù)過程中所編制的文件;但這種個(gè)人文件必須是主文本的復(fù)制品,必須同主文本完全一致,若要修改,必須首先修改主文本;
e.不同開發(fā)人員所擁有的個(gè)人文件通常是主文本的各種子集;所謂子集是指把主文本的各個(gè)部分根據(jù)承擔(dān)不同任務(wù)的人員或部門的工作需要加以復(fù)制、組裝而成的若干個(gè)文件的集合;文件管理人員。應(yīng)該列出一份不同子集的分發(fā)對(duì)象的清單,按照清單及時(shí)把文件分發(fā)給有關(guān)人員或部門;
f.一份文件如果已經(jīng)被另一份新的文件所代替,則原文件應(yīng)該被注銷;文件管理人中要隨時(shí)整理主文本,及時(shí)反映出文件的變化和增加情況,及時(shí)分發(fā)文件;
g.當(dāng)一個(gè)項(xiàng)目的開發(fā)工作臨近結(jié)束時(shí),文件管理人員應(yīng)逐個(gè)收回開發(fā)集體內(nèi)每個(gè)成員的個(gè)人文件,并檢查這些個(gè)人文件的內(nèi)容;經(jīng)驗(yàn)表明,這些個(gè)人文件往往可能比主文本更詳細(xì),或同主文本的內(nèi)容有所不同,必須認(rèn)真監(jiān)督有關(guān)人員進(jìn)行修改,使主文本能真正反映實(shí)際的開發(fā)結(jié)果。
6.4文件的修改管理
在一個(gè)項(xiàng)目的開發(fā)過程中的任何時(shí)刻,開發(fā)集體內(nèi)的所有成員都可能對(duì)開發(fā)工作的已有成果——文件,提出進(jìn)行修改的要求。提出修改要求的理由可能是各種各樣的,進(jìn)行修改而引起的影響可能很小,也可能會(huì)牽涉到本項(xiàng)目的很多方面。因此,修改活動(dòng)的進(jìn)行必須謹(jǐn)慎,必須對(duì)修改活動(dòng)的進(jìn)行加以管理,必須執(zhí)行修改活動(dòng)的規(guī)程,使整個(gè)修改活動(dòng)有控制地進(jìn)行。
修改活動(dòng)可分如下五個(gè)步驟進(jìn)行:
a.提議開發(fā)集體中的任何一個(gè)成員都可以向項(xiàng)目負(fù)責(zé)人提出修改建議,為此應(yīng)該填寫一份修改建議表,說明修改的內(nèi)容、所修改的文件和部位、以及修改理由;
b.評(píng)議由項(xiàng)目負(fù)責(zé)人或項(xiàng)目負(fù)責(zé)人指定的人員對(duì)該修改建議進(jìn)行評(píng)議,包括審查該項(xiàng)修改的必要性、確定這一修改的影響范圍、研究進(jìn)行修改的方法、步驟和實(shí)施計(jì)劃;
c.審核一般由項(xiàng)目負(fù)責(zé)人進(jìn)行審核,包括核實(shí)修改的自的和要求、核實(shí)修改活動(dòng)將帶來的影響、審核修改活動(dòng)計(jì)劃是否可行;
d.批準(zhǔn)在一般情況下,批準(zhǔn)權(quán)屬于該開發(fā)單位的部門負(fù)責(zé)人;在批準(zhǔn)時(shí),主要是決斷修改工作中各項(xiàng)活動(dòng)的先后順序及各自的完成日期,以保證整個(gè)開發(fā)工作按原定計(jì)劃日期完成;
e.實(shí)施由項(xiàng)目負(fù)責(zé)人按照已批準(zhǔn)的修改活動(dòng)計(jì)劃,安排各項(xiàng)修改活動(dòng)的負(fù)責(zé)人員進(jìn)行修改,建立修改記錄、產(chǎn)生新的文件以取代原有文件、最后把文件交文件管理人員歸檔,并分發(fā)給有關(guān)的持有者。
第二篇各種文件的內(nèi)容要求
本篇將對(duì)引言中提到的十四種文件提供內(nèi)容要求,作為文件編制的技術(shù)標(biāo)準(zhǔn)。7可行性研究報(bào)告
可行性研究報(bào)告的編寫目的是:說明該軟件開發(fā)項(xiàng)目的實(shí)現(xiàn)在技術(shù)、經(jīng)濟(jì)和社會(huì)條件方面的可行性;評(píng)述為了合理地達(dá)到開發(fā)目標(biāo)而可能選擇的各種方案;說明并論證所選定的方案。
可行性研究報(bào)告的編寫內(nèi)容要求如下:
7.1引言
7.1C1編寫目的
7.1.2背景
7.1.3定義
7.1.4參考資料7
7.2可行性研究的前提
7.2.1要求
7.2.2目標(biāo)
7.2.3條件、假定和限制
7.2.4進(jìn)行可行性研究的方法
7.2.5評(píng)價(jià)尺度
7.3對(duì)現(xiàn)有系統(tǒng)的分析
7.3.1數(shù)據(jù)流程和處理流程
7.3.2工作負(fù)荷
7.3.3費(fèi)用開支
7.3.4人員
7.3.5設(shè)備
7.3.6局限性
7.4所建議的系統(tǒng)
7.4.1對(duì)所建議系統(tǒng)的說明
7.4.2數(shù)據(jù)流程和處理流程
7.4.3改進(jìn)之處
7.4.4影響
7.4.4.1對(duì)設(shè)備的影響
7.4.4.2對(duì)軟件的影響
7.4.4.3對(duì)用戶單位機(jī)構(gòu)的影響
7.4.4.4對(duì)系統(tǒng)運(yùn)行的影響
7.4.4.5對(duì)開發(fā)的影響
7.4,4.6對(duì)地點(diǎn)和設(shè)施的影響
7.4.4.7對(duì)經(jīng)費(fèi)開支的影響
7.4.5局限性
7.4.6技術(shù)條件方面的可行性
7.5可選擇的其他系統(tǒng)方案
7.5.1可選擇的系統(tǒng)方案1
7.5.2可選擇的系統(tǒng)方案2
......
7.6投資及收益分析
7.6.1支出
7.6.1.1基本建設(shè)投資
7.6.1.2其他一次性支出
7.6.1.3非一次性支出
7.6.2收益
7.6,2.1一次性收益
7.6.2.2非一次性收益
7.6.2.3不可定量的收益
7.6.3收益/投資比
7.6.4投資回收周期
7.6.5敏感性分析
7.7社會(huì)條件方面的可行性
7.7.1法律方面的可行性
7.7.2使用方面的可行性
7.8結(jié)論8項(xiàng)目開發(fā)計(jì)劃
編制項(xiàng)目開發(fā)計(jì)劃的目的是用文件的形式,把對(duì)于在開發(fā)過程中各項(xiàng)工作的負(fù)責(zé)人員、開發(fā)進(jìn)度、所需經(jīng)費(fèi)預(yù)算、所需軟、硬件條件等問題作出的安排記載下來,以便根據(jù)本計(jì)劃開展和檢查本項(xiàng)目的開發(fā)工作。編制內(nèi)容要求如下:
8.1引言
8.1.1編寫目的
8.1.2背景
8.1.3定義
8.1.4參考資料
8.2項(xiàng)目概述
8.2.1作內(nèi)容
8.2.2主要參加人員
8.2.3產(chǎn)品及成果
8.2.3.1程序
8.2.3.2文件
8.2.3.3服務(wù)
8.2.3.4非移交產(chǎn)品
8.2.4驗(yàn)收標(biāo)準(zhǔn)
8..2.5完成項(xiàng)目的最遲期限
8.2.6本計(jì)劃的審查者與批準(zhǔn)者
8.3實(shí)施總計(jì)劃
8.3.1工作任務(wù)的分解
8.3.2接口人員
8.3.3進(jìn)度
8.3.4預(yù)算
8.3.5關(guān)鍵問題
8.4支持條件
8.4.1計(jì)算機(jī)系統(tǒng)支持
8.4.2需要用戶承擔(dān)的工作
8.4.3需由外單位提供的條件
8.5專題計(jì)劃要點(diǎn)9軟件需求說明書
軟件需求說明書的編制是為了使用戶和軟件開發(fā)者雙方對(duì)該軟件的初始規(guī)定有一個(gè)共同的理解,使之成為整個(gè)開發(fā)工作的基礎(chǔ)。編制軟件需求說明書的內(nèi)容要求如下:
9.1引言
9.1.1編寫目的
9.1.2背景
9.1.3定義
9.1.4參考資料
9.2任務(wù)概述
9.2.1目標(biāo)
9.2.2用戶的特點(diǎn)
9.2.3假定與約束
9.3需求規(guī)定
9.3.1對(duì)功能的規(guī)定
9.3.2對(duì)性能的規(guī)定
9.3.2.1精度
9.3.2.2時(shí)間特性耍求
9.3.2.3靈活性
9.3.3輸入輸出要求
9.3.4數(shù)據(jù)管理能力要求
9.3.5故障處理要求
9.3.6其他專門要求
9.4運(yùn)行環(huán)境規(guī)定
9.4.1設(shè)備
9.4.2支持軟件
9.4.3接口
9.4.4控制10數(shù)據(jù)要求說明書
數(shù)據(jù)要求說明書的編制目的是為了向整個(gè)開發(fā)時(shí)期提供關(guān)于被處理數(shù)據(jù)的描述和數(shù)據(jù)采集要求的技術(shù)信息。編制數(shù)據(jù)要求說明書的內(nèi)容要求如下:
10.1引言
10.1.1編寫目的
10.1.2背景
10.1.3定義
10.1.4參考資料
10.2數(shù)據(jù)的邏輯描述
10.2.1靜態(tài)數(shù)據(jù)
10.2.2動(dòng)態(tài)輸入數(shù)據(jù)
10.2.3動(dòng)態(tài)輸出數(shù)據(jù)
10.2.4內(nèi)部生成數(shù)據(jù)
10.2.5數(shù)據(jù)約定
10.3數(shù)據(jù)的采集
10.3.1要求和范圍
10.3.2輸入的承擔(dān)者
10.3.3處理
10.3.4影響。11概要設(shè)計(jì)說明書
概要設(shè)計(jì)說明書又可稱系統(tǒng)設(shè)計(jì)說明書,這里所說的系統(tǒng)是指程序系統(tǒng)。編制的目的是說明對(duì)程序系統(tǒng)的設(shè)計(jì)考慮,包括程序系統(tǒng)的基本處。流程、程序系統(tǒng)的組織結(jié)構(gòu)、模塊劃分、功能分配、接口設(shè)計(jì)。運(yùn)行設(shè)計(jì)、數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)和出錯(cuò)處理設(shè)計(jì)等,為程序的詳細(xì)設(shè)計(jì)提供基礎(chǔ)。編制概要設(shè)計(jì)說明書的內(nèi)容要求如下:
11.1引言
11.1.1編寫目的
11.1.2背景
11.1.3定義
11.1.4參考資料
11.2總體設(shè)計(jì)
11.2.1需求規(guī)定
11.2.2運(yùn)行環(huán)境
11.2.3基本設(shè)計(jì)概念和處理流程
11.2.4結(jié)構(gòu)
11.2.5功能需求與程序的關(guān)系
11.2.6人工處理過程
11.2.7尚未解決的問題
11.3接口設(shè)計(jì)
11.3.1用戶接口
11.3.2外部接口
11.3.3內(nèi)部接口
11.4運(yùn)行設(shè)計(jì)
11.4.1運(yùn)行模塊組合
11.4.2運(yùn)行控制
11.4.3運(yùn)行時(shí)間
11.5系統(tǒng)論據(jù)結(jié)構(gòu)設(shè)計(jì)
11.5.1邏輯結(jié)構(gòu)設(shè)計(jì)要點(diǎn)
11.5.2物理結(jié)構(gòu)設(shè)計(jì)要點(diǎn)
11.5.3數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系
11.6系統(tǒng)出錯(cuò)處理設(shè)計(jì)
11.6.1出錯(cuò)信息
11.6.2補(bǔ)救措施
11.63系統(tǒng)維護(hù)設(shè)計(jì)12詳細(xì)設(shè)計(jì)說明書
詳細(xì)設(shè)計(jì)說明書又可稱程序設(shè)計(jì)說明書。編制目的是說明一個(gè)軟件系統(tǒng)各個(gè)層次中的每一個(gè)程序(每個(gè)模塊或子程序)的設(shè)計(jì)考慮,如果一個(gè)軟件系統(tǒng)比較簡單,層次很少,本文件可以不單獨(dú)編寫,有關(guān)內(nèi)容合并入概要設(shè)計(jì)說明書。對(duì)詳細(xì)設(shè)計(jì)說明書的內(nèi)容要求如下:
12.1引言
12.1.1編寫目的
12.1.2背景
12.1.3定義
12.1.4參考資料
12.2程序系統(tǒng)的組織結(jié)構(gòu)
12.3程序1(標(biāo)識(shí)符)設(shè)計(jì)說明
12.3.1程序描述
12.3.2功能
12.3.3性能
12.3.4輸入項(xiàng)
12.3.5輸出項(xiàng)
12.3.6算法
12.3.7流程邏輯
12.3.8接口
12.3..9存儲(chǔ)分配
12.3.10注釋設(shè)計(jì)
12.3.11限制條件
12.3.12測試計(jì)劃.
12.3.13尚未解決的問題
12.4程序2(標(biāo)識(shí)符)設(shè)計(jì)說明
......
13數(shù)據(jù)庫設(shè)計(jì)說明書
數(shù)據(jù)庫設(shè)計(jì)說明書的編制目的是對(duì)于設(shè)計(jì)中的數(shù)據(jù)庫的所有標(biāo)識(shí)、邏輯結(jié)構(gòu)和物理結(jié)構(gòu)作出具體的設(shè)計(jì)規(guī)定。其內(nèi)容要求如下:
13.1引言
13.1.1編寫目的
13.1.2背景
13.1.3定義
13.1.4參考資料
13.2外部設(shè)計(jì)
13.2.1標(biāo)識(shí)符和狀態(tài)
13.2.2使用它的程序
13.2.3約定
13.2.4專門指導(dǎo)
13.2.5支持軟件
13.3結(jié)構(gòu)設(shè)計(jì)
13.3.1概念結(jié)構(gòu)設(shè)計(jì)
13.3.2邏輯結(jié)構(gòu)設(shè)計(jì)
13.3.3物理結(jié)構(gòu)設(shè)計(jì)
13.4運(yùn)用設(shè)計(jì)
13.4.1數(shù)據(jù)字典設(shè)計(jì)
13.4.2安全保密設(shè)計(jì)
14用戶手冊
用戶手冊的編制是要使用非專門術(shù)語的語言,充分地描述該軟件系統(tǒng)所具有的功能及基本的使用方法。使用戶(或潛在用戶)通過本手冊能夠了解該軟件的用途,并且能夠確定在什么情況下,如何使用它。具體的內(nèi)容要求如下:
14.1引言
14.1.1編寫目的
14.1.2背景
14.1.3定義
14.1.4參考資料
14.2用途
14.2.1功能
14.2.2性能
14.2.2.1精度
14.2.2.2時(shí)間特性
14.2.2.3靈活性
14.2.3安全保密
14.3運(yùn)行環(huán)境
14.3.1硬設(shè)備
14.3.2支持軟件
14.3.3數(shù)據(jù)結(jié)構(gòu)
14.4使用過程
14.4.1安裝與初始化
14.4.2輸入
14.4.2.1輸入數(shù)據(jù)的現(xiàn)實(shí)背景
14.4.2.2輸入格式
14.4.2.3輸入舉例
14.4.3輸出
14.4.3.1輸出數(shù)據(jù)的現(xiàn)實(shí)背景
14.4.3.2輸出格式
14.4.3.3輸出舉例
14.4.4文卷查詢
14.4.5出錯(cuò)處理與恢復(fù)
14.4.6終端操作15操作手冊
操作手冊的編制是為了向操作人員提供該軟件每一個(gè)運(yùn)行的具體過程和有關(guān)知識(shí),包括操作方法的細(xì)節(jié)。具體的內(nèi)容要求如下:
15.1引言
15.1.1編寫目的
15.1.2背景
15.1.3定義
15.1.4參考資料
15.2軟件概述
15.2.1軟件的結(jié)構(gòu)
15.2.2程序表
15.2.3文卷表
15.3安裝與初始化
15.4運(yùn)行說明
15.4.1運(yùn)行表
15.4.2運(yùn)行步驟
15.4.3運(yùn)行1(標(biāo)識(shí)符)說明
15.4.3.1運(yùn)行控制
15.4.3.2操作信息
15.4.3.3輸入一輸出文卷
15.4.3.4輸出文段
15.4.3.5輸出文段的復(fù)制
15.4.3.6啟動(dòng)恢復(fù)過程
15.4.4運(yùn)行2(標(biāo)識(shí)符)說明
......
15.5非常現(xiàn)過程
15.6遠(yuǎn)程操作16模塊開發(fā)卷宗
模塊開發(fā)卷宗是在模塊開發(fā)過程中逐步編寫出來的,每完成一個(gè)模塊或一組密切相關(guān)的模塊的復(fù)審時(shí)編寫一份,應(yīng)該把所有的模塊開發(fā)卷宗匯集在一起。編寫的目的是記錄和匯總低層次開發(fā)的進(jìn)度和結(jié)果,以便于對(duì)整個(gè)模塊開發(fā)工作的管理和復(fù)審,并為將來的維護(hù)提供非常有用的技術(shù)信息。具體的內(nèi)容要求如下:
16.1標(biāo)題
16.2模塊開發(fā)情況表(見下表)
模塊開發(fā)情況表
16.3功能說明
16.4設(shè)計(jì)說明
16.5源代碼清單
16.6測試說明
16.7復(fù)審的結(jié)論17測試計(jì)劃
這里所說的測試,主要是指整個(gè)程序系統(tǒng)的組裝測試和確認(rèn)測試。本文件的編制是為了提供一個(gè)對(duì)該軟件的測試計(jì)劃,包括對(duì)每項(xiàng)測試活動(dòng)的內(nèi)容、進(jìn)度安排、設(shè)計(jì)考慮、測試數(shù)據(jù)的整理方法及評(píng)價(jià)準(zhǔn)則。具體的內(nèi)容要求如下:
17.1引言
17.1.1編寫目的
17.1.2背景
17.1.3定義
17.1.4參考資料
17.2計(jì)劃
17.2.1軟件說明
17.2.2測試內(nèi)容
17.2.3測試1(標(biāo)識(shí)符)
17.2.3.1進(jìn)度安排
17.2.3.2條件
17.2.3.3測試資料
17.2.3.4測試培訓(xùn)
17.2.4測試2(標(biāo)識(shí)符)
......
17.3測試設(shè)計(jì)說明
17.3.1測試l(標(biāo)識(shí)符)
17.3.1.1控制
17.3.1.2輸入
17.3.1.3輸出
17.3.1.4過程
17.3.2測試2(標(biāo)識(shí)符)
.......
17.4評(píng)價(jià)準(zhǔn)則
17.4.1范圍
17.4.2數(shù)據(jù)整理
17.4.3尺度18測試分析報(bào)告
測試分析報(bào)告的編寫是為了把組裝測試和確認(rèn)測試的結(jié)果、發(fā)現(xiàn)及分析寫成文件加以記載,具體的內(nèi)容要求如下:
18.1引言
18.1.1編寫目的
18.1.2背景
18.1.3定義
18.1.4參考資料
18.2測試概要
18.3測試結(jié)果及發(fā)現(xiàn)
18.3.1測試1(標(biāo)識(shí)符)
18.3.2測試2(標(biāo)識(shí)符)
......
18.4對(duì)軟件功能的結(jié)論
18.4.1功能1(標(biāo)識(shí)符)
18.4.1.1能力
18.4.1.2限制
18.4.2功能2(標(biāo)識(shí)符)
18.5分析摘要
18.5.1能力
18.5.2缺陷和限制
18.5.3建議
18.5.4評(píng)價(jià)
18.6測試資源消耗
19開發(fā)進(jìn)度月報(bào)
開發(fā)進(jìn)度月報(bào)的編制目的是及時(shí)向有關(guān)管理部門匯報(bào)項(xiàng)目開發(fā)的進(jìn)展和情況,以便及時(shí)發(fā)現(xiàn)和處理開發(fā)過程中出現(xiàn)的問題。一般地,開發(fā)進(jìn)度月報(bào)是以項(xiàng)目組為單位每月編寫的。如果被開發(fā)的軟件系統(tǒng)規(guī)模比較大,整個(gè)工程項(xiàng)目被劃分給若干個(gè)分項(xiàng)目組承擔(dān),開發(fā)進(jìn)度月報(bào)將以分項(xiàng)目組為單位按月編寫。具體的內(nèi)容要求如下:
19.1標(biāo)題
19.2工程進(jìn)度與狀態(tài)
19.2.1進(jìn)度
19.2.2狀態(tài)
19.3資源耗用與狀態(tài)
19.3.1資源耗用
19.3.1.1工時(shí)
19.3.1.2機(jī)時(shí)
19.3.2狀態(tài)
19.4經(jīng)費(fèi)支出與狀態(tài)
19.4.1經(jīng)費(fèi)支出
19.4.1.1支持性費(fèi)用
19.4.1.2設(shè)備購置費(fèi)
19.4.2狀態(tài)
19.5下個(gè)月的工作計(jì)劃
19.6建議
20項(xiàng)目開發(fā)總結(jié)報(bào)告
項(xiàng)目開發(fā)總結(jié)報(bào)告的編制是為了總結(jié)本項(xiàng)目開發(fā)工作的經(jīng)驗(yàn),說明實(shí)際取得的開發(fā)結(jié)果以及對(duì)整個(gè)開發(fā)工作的各個(gè)方面的評(píng)價(jià)。具體的內(nèi)容要求如下:
20.1引言
20.1.1編寫目的
20.1.2背景
20.1.3定義
20.1.4參考資料
20.2.1產(chǎn)品
20.2實(shí)際開發(fā)結(jié)果
20.2.2主要功能和性能
20.2.3基本流程
20.2.4進(jìn)度
20.2.5費(fèi)用
20.3開發(fā)工作評(píng)價(jià)
20.3.1對(duì)生產(chǎn)效率的評(píng)價(jià)
20.3.2對(duì)產(chǎn)品質(zhì)量的評(píng)價(jià)
20.3.3對(duì)技術(shù)方法的評(píng)價(jià)
20.3.4出錯(cuò)原因的分析
20.4經(jīng)驗(yàn)與教訓(xùn)附錄A可行性研究報(bào)告的編寫提示(參考件)
A.1引言
A.1.1編寫目的說明編寫本可行性研究報(bào)告的目的,指出預(yù)期的讀者。
A.1.2背景
說明:
a.所建議開發(fā)的軟件系統(tǒng)的名稱;
b.本項(xiàng)目的任務(wù)提出者、開發(fā)者、用戶及實(shí)現(xiàn)該軟件的計(jì)算中心或計(jì)算機(jī)網(wǎng)絡(luò);
C.該軟件系統(tǒng)同其他系統(tǒng)或其他機(jī)構(gòu)的基本的相互來往關(guān)系。
A.1.3定義
列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。
A.1.4參考資料
列出用得著的參考資料,如:
a.本項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同、上級(jí)機(jī)關(guān)的批文;
b.屬于本項(xiàng)目的其他已發(fā)表的文件;
C.本文件中各處引用的文件、資料,包括所需用到的軟件開發(fā)標(biāo)準(zhǔn)。|
列出這些文件資料的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位,說明能夠得到這些文件資料的來源。A.2可行性研究的前提
說明對(duì)所建議的開發(fā)項(xiàng)目進(jìn)行可行性研究的前提,如要求、目標(biāo)、假定、限制等。
A.2.1要求
說明對(duì)所建議開發(fā)的軟件的基本要求,如:
a.功能;
b.性能;
C.輸出如報(bào)告、文件或數(shù)據(jù),對(duì)每項(xiàng)輸出要說明其特征,如用途、產(chǎn)生頻度、接口以及分發(fā)對(duì)象;
d.輸入說明系統(tǒng)的輸入,包括數(shù)據(jù)的來源、類型、數(shù)量、數(shù)據(jù)的組織以及提供的頻度;
e.處理流程和數(shù)據(jù)流程用圖表的方式表示出最基本的數(shù)據(jù)流程和處理流程,并輔之以敘述;
f.在安全與保密方面的要求;
g.同本系統(tǒng)相連接的其他系統(tǒng);
h.完成期限。
A.2.2目標(biāo)
說明所建議系統(tǒng)的主要開發(fā)目標(biāo),如:
a.人力與設(shè)備費(fèi)用的減少;
b.處理速度的提高;
C.控制精度或生產(chǎn)能力的提高;
d.管理信息服務(wù)的改進(jìn);
e.自動(dòng)決策系統(tǒng)的改進(jìn);
f.人員利用率的改進(jìn)。
A.2.3條件、假定和限制
說明對(duì)這項(xiàng)開發(fā)中給出的條件、假定和所受到的限制,如:
a.所建議系統(tǒng)的運(yùn)行壽命的最小值;
b.進(jìn)行系統(tǒng)方案選擇比較的時(shí)間;
c.經(jīng)費(fèi)、投資方面的來源和限制;
d.法律和政策方面的限制;
e.硬件、軟件、運(yùn)行環(huán)境和開發(fā)環(huán)境方面的條件和限制;
f.可利用的信息和資源;
g.系統(tǒng)投入使用的最晚時(shí)間。
A.2.4進(jìn)行可行性研究的方法
說明這項(xiàng)可行性研究將是如何進(jìn)行的,所建議的系統(tǒng)將是如何評(píng)價(jià)的。摘要說明所使用的基本方法和策略,如調(diào)查、加權(quán)、確定模型、建立基準(zhǔn)點(diǎn)或仿真等。
A.2.5評(píng)價(jià)尺度
說明對(duì)系統(tǒng)進(jìn)行評(píng)價(jià)時(shí)所使用的主要尺度,如費(fèi)用的多少、各項(xiàng)功能的優(yōu)先次序、開發(fā)時(shí)間的長短及使用中的難易程度。
A.3對(duì)現(xiàn)有系統(tǒng)的分析
這里的現(xiàn)有系統(tǒng)是指當(dāng)前實(shí)際使用的系統(tǒng),這個(gè)系統(tǒng)可能是計(jì)算機(jī)系統(tǒng),也可能是一個(gè)機(jī)械系統(tǒng)甚至是一個(gè)人工系統(tǒng)。
分析現(xiàn)有系統(tǒng)的目的是為了進(jìn)一步闡明建議中的開發(fā)新系統(tǒng)或修改現(xiàn)有系統(tǒng)的必要性。
A.3.1處理流程和數(shù)據(jù)流程
說明現(xiàn)有系統(tǒng)的基本的處理流程和數(shù)據(jù)流程。此流程可用圖表即流程圖的形式表示,并加以敘述。
A.3.2工作負(fù)荷
列出現(xiàn)有系統(tǒng)所承擔(dān)的工作及工作量。
A.3.3費(fèi)用開支
列出由于運(yùn)行現(xiàn)有系統(tǒng)所引起的費(fèi)用開支,如人力、設(shè)備、空間、支持性服務(wù)、材料等項(xiàng)開支以及開支總額。
A.3.4人員
列出為了現(xiàn)有系統(tǒng)的運(yùn)行和維護(hù)所需要的人員的專業(yè)技術(shù)類別和數(shù)量。
A.3.5設(shè)備
列出現(xiàn)有系統(tǒng)所使用的各種設(shè)備。
A.3.6局限性
列出本系統(tǒng)的主要的局限性,例如處理時(shí)間趕不上需要,響應(yīng)不及時(shí),數(shù)據(jù)存儲(chǔ)能力不足,處理功能不夠等。并且要說明,為什么對(duì)現(xiàn)有系統(tǒng)的改進(jìn)性維護(hù)已經(jīng)不能解決問題。
A.4所建議的系統(tǒng)
本章將用來說明所建議系統(tǒng)的目標(biāo)和要求將如何被滿足。
A.4.1對(duì)所建議系統(tǒng)的說明
概括地說明所建議系統(tǒng),并說明在第A.2章中列出的那些要求將如何得到滿足,說明所使用的基本方法及理論根據(jù)。
A.4.2處理流程和數(shù)據(jù)流程
給出所建議系統(tǒng)的處理流程和數(shù)據(jù)流程。
A.4.3改進(jìn)之處
按A.2.2條中列出的目標(biāo),逐項(xiàng)說明所建議系統(tǒng)相對(duì)于現(xiàn)存系統(tǒng)具有的改進(jìn)。
A.4.4影響
說明在建立所建議系統(tǒng)時(shí),預(yù)期將帶來的影響,包括:
A.4.4.1對(duì)設(shè)備的影響
說明新提出的設(shè)備要求及對(duì)現(xiàn)存系統(tǒng)中尚可使用的設(shè)備須作出的修改。
A.4.4.2對(duì)軟件的影響
說明為了使現(xiàn)存的應(yīng)用軟件和支持軟件能夠同所建議系統(tǒng)相適應(yīng)。而需要對(duì)這些軟件所進(jìn)行的修改和補(bǔ)充。
A.4.4.3對(duì)用戶單位機(jī)構(gòu)的影響
說明為了建立和運(yùn)行所建議系統(tǒng),對(duì)用戶單位機(jī)構(gòu)、人員的數(shù)量和技術(shù)水平等方面的全部要求。
A.4.4.4對(duì)系統(tǒng)運(yùn)行過程的影響
說明所建議系統(tǒng)對(duì)運(yùn)行過程的影響,如:
a.用戶的操作規(guī)程;
b.運(yùn)行中心的操作規(guī)程;
C.運(yùn)行中心與用戶之間的關(guān)系;
d.源數(shù)據(jù)的處理;
e.?dāng)?shù)據(jù)進(jìn)入系統(tǒng)的過程;
f.對(duì)數(shù)據(jù)保存的要求,對(duì)數(shù)據(jù)存儲(chǔ)、恢復(fù)的處理;
g.輸出報(bào)告的處理過程、存儲(chǔ)媒體和調(diào)度方法;
h.系統(tǒng)失效的后果及恢復(fù)的處理辦法。
A.4.4.5對(duì)開發(fā)的影響
說明對(duì)開發(fā)的影響,如:
a.為了支持所建議系統(tǒng)的開發(fā),用戶需進(jìn)行的工作;
b.為了建立一個(gè)數(shù)據(jù)庫所要求的數(shù)據(jù)資源;
C.為了開發(fā)和測驗(yàn)所建議系統(tǒng)而需要的計(jì)算機(jī)資源;
d.所涉及的保密與安全問題。
A.4.4.6對(duì)地點(diǎn)和設(shè)施的影響
說明對(duì)建筑物改造的要求及對(duì)環(huán)境設(shè)施的要求。
A.4.4.7對(duì)經(jīng)費(fèi)開支的影響
扼要說明為了所建議系統(tǒng)的開發(fā),設(shè)計(jì)和維持運(yùn)行而需要的各項(xiàng)經(jīng)費(fèi)開支。
A.4.5局限性
說明所建議系統(tǒng)尚存在的局限性以.及這些問題未能消除的原因。
A.4.6技術(shù)條件方面的可行性
本節(jié)應(yīng)說明技術(shù)條件方面的可行性,如:
a.在當(dāng)前的限制條件下,該系統(tǒng)的功能目標(biāo)能否達(dá)到;
b.利用現(xiàn)有的技術(shù),該系統(tǒng)的功能能否實(shí)現(xiàn);
C.對(duì)開發(fā)人員的數(shù)量和質(zhì)量的要求并說明這些要求能否滿足;
d.在規(guī)定的期限內(nèi),本系統(tǒng)的開發(fā)能否完成。
A.5可選擇的其他系統(tǒng)方案
扼要說明曾考慮過的每一種可選擇的系統(tǒng)方案,包括需開發(fā)的和可從國內(nèi)國外直接購買的,如果沒有供選擇的系統(tǒng)方案可考慮,則說明這一點(diǎn)。
A.5.1可選擇的系統(tǒng)方案1
參照第A.4章的提綱,說明可選擇的系統(tǒng)方案1,并說明它未被選中的理由。
A.5.2可選擇的系統(tǒng)方案2
按類似A.5.1條的方式說明第2個(gè)乃至第。個(gè)可選擇的系統(tǒng)方案。
......
A.6投資及效益分析
A.6.1支出
對(duì)于所選擇的方案,說明所需的費(fèi)用。如果已有一個(gè)現(xiàn)存系統(tǒng),則包括該系統(tǒng)繼續(xù)運(yùn)行期間所需的費(fèi)用。
A.6.1.1基本建設(shè)投資
包括采購、開發(fā)和安裝下列各項(xiàng)所需的費(fèi)用,如:
a.房屋和設(shè)施;
b.ADP設(shè)備;
C.?dāng)?shù)據(jù)通訊設(shè)備;
d.環(huán)境保護(hù)設(shè)備;
e.安全與保密設(shè)備;
f.ADP操作系統(tǒng)的和應(yīng)用的軟件;
g.?dāng)?shù)據(jù)庫管理軟件。
A.6.1.2其他一次性支出
包括下列各項(xiàng)所需的費(fèi)用,如:
a.研究(需求的研究和設(shè)計(jì)的研究);
b.開發(fā)計(jì)劃與測量基準(zhǔn)的研究;
C.?dāng)?shù)據(jù)庫的建立;
d.ADP軟件的轉(zhuǎn)換;
e.檢查費(fèi)用和技術(shù)管理性費(fèi)用;
f.培訓(xùn)費(fèi)、旅差費(fèi)以及開發(fā)安裝人員所需要的一次性支出;
g.人員的退休及調(diào)動(dòng)費(fèi)用等。
A.6.1.3非一次性支出
列出在該系統(tǒng)生命期內(nèi)按月或按季或按年支出的用于運(yùn)行和維護(hù)的費(fèi)用,包括:
a.設(shè)備的租金和維護(hù)費(fèi)用;
b軟件的租金和維護(hù)費(fèi)用;
C.?dāng)?shù)據(jù)通訊方面的租金和維護(hù)費(fèi)用;
d.人員的工資、獎(jiǎng)金;
e.房屋、空間的使用開支;
f.公用設(shè)施方面的開支;
g.保密安全方面的開支;
h.其他經(jīng)常性的支出等。
A.6.2收益
對(duì)于所選擇的方案,說明能夠帶來的收益,這里所說的收益,表現(xiàn)為開支費(fèi)用的減少或避免、差錯(cuò)的減少、靈活性的增加、動(dòng)作速度的提高和管理計(jì)劃方面的改進(jìn)等,包括;
A.6.2.1一次性收益
說明能夠用人民幣數(shù)目表示的一次性收益,可按數(shù)據(jù)處理、用戶、管理和支持等項(xiàng)分類敘述,如:
a.開支的縮減包括改進(jìn)了的系統(tǒng)的運(yùn)行所引起的開支縮減,如資源要求的減少,運(yùn)行效率的改進(jìn),數(shù)據(jù)進(jìn)入、存貯和恢復(fù)技術(shù)的改進(jìn),系統(tǒng)性能的可監(jiān)控,軟件的轉(zhuǎn)換和優(yōu)化,數(shù)據(jù)壓縮技術(shù)的采用,處理的集中化/分布化等;
b.價(jià)值的增升包括由于一個(gè)應(yīng)用系統(tǒng)的使用價(jià)值的增升所引起的收益,如資源利用的改進(jìn),管理和運(yùn)行效率的改進(jìn)以及出錯(cuò)率的減少等;
C.其他如從多余設(shè)備出售回收的收入等。
A.6.2.2非一次性收益
說明在整個(gè)系統(tǒng)生命期內(nèi)由于運(yùn)行所建議系統(tǒng)而導(dǎo)致的按月的、按年的能用人民幣數(shù)目表示的收益,包括開支的減少和避免。
A.6.2.3不可定量的收益
逐項(xiàng)列出無法直接用人民幣表示的收益,如服務(wù)的改進(jìn),由操作失誤引起的風(fēng)險(xiǎn)的減少,信息掌握情況的改進(jìn),組織機(jī)構(gòu)給外界形象的改善等。有些不可捉摸的收益只能大概估計(jì)或進(jìn)行極值估計(jì)(按最好和最差情況估計(jì))。
A.6.3收益/投資比
求出整個(gè)系統(tǒng)生命期的收益/投資比值。
A.6.4投資回收周期
求出收益的累計(jì)數(shù)開始超過支出的累計(jì)數(shù)的時(shí)間。
A.6.5敏感性分析
所謂敏感性分析是指一些關(guān)鍵性因素如系統(tǒng)生命期長度、系統(tǒng)的工作負(fù)荷量、工作負(fù)荷的類型與這些不同類型之間的合理搭配、處理速度要求、設(shè)備和軟件的配置等變化時(shí),對(duì)開支和收益的影響最靈敏的范圍的估計(jì)。在敏感性分析的基礎(chǔ)上做出的選擇當(dāng)然會(huì)比單一選擇的結(jié)果要好一些。
A.7社會(huì)因素方面的可行性
本章用來說明對(duì)社會(huì)因素方面的可行性分析的結(jié)果,包括:
A.7.1法律方面的可行性
法律方面的可行性問題很多,如合同責(zé)任、侵犯專利權(quán)、侵犯版權(quán)等方面的陷井,軟件人員通常是不熟悉的,有可能陷入,務(wù)必要注意研究。
A.7.2使用方面的可行性
例如從用戶單位的行政管理、工作制度等方面來看,是否能夠使用該軟件系統(tǒng);從用戶單位的工作人員的素質(zhì)來看,是否能滿足使用該軟件系統(tǒng)的要求等等,都是要考慮的。
A.8結(jié)論
在進(jìn)行可行性研究報(bào)告的編制時(shí),必須有一個(gè)研究的結(jié)論。結(jié)論可以是:
a.可以立即開始進(jìn)行;
b.需要推遲到某些條件(例如資金、人力、設(shè)備等)落實(shí)之后才能開始進(jìn)行;
c.需要對(duì)開發(fā)目標(biāo)進(jìn)行某些修改之后才能開始進(jìn)行;
d.不能進(jìn)行或不必進(jìn)行(例如因技術(shù)不成熟、經(jīng)濟(jì)上不合算等)。附錄B項(xiàng)目開發(fā)計(jì)劃的編寫提示
B.1引言
B.1.1編寫目的
說明編寫這份項(xiàng)目開發(fā)計(jì)劃的目的,并指出預(yù)期的讀者。
B.1.2背景
說明:
a.待開發(fā)的軟件系統(tǒng)的名稱;
b.本項(xiàng)目的任務(wù)提出者、開發(fā)者、用戶及實(shí)現(xiàn)該軟件的計(jì)算中心或計(jì)算機(jī)網(wǎng)絡(luò);
C.該軟件系統(tǒng)同其他系統(tǒng)或其他機(jī)構(gòu)的基本的相互來往關(guān)系。
B.1.3定義
列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。
B.1.4參考資料
列出用得著的參考資料,如:
a.本項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同、上級(jí)機(jī)關(guān)的批文;
b.屬于本項(xiàng)目的其他已發(fā)表的文件;
C.本文件中各處引用的文件、資料,包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件資料的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位,說明能夠得到這些文件資料的來源。
B.2項(xiàng)目概述
B.2.1工作內(nèi)容
簡要地說明在本項(xiàng)目的開發(fā)中須進(jìn)行的各項(xiàng)主要工作。
B.2.2主要參加人員
扼要說明參加本項(xiàng)目開發(fā)工作的主要人員的情況,包括他們的技術(shù)水平。
B.2.3產(chǎn)品
B.2.31程序
列出需移交給用戶的程序的名稱、所用的編程語言及存儲(chǔ)程序的媒體形式,并通過引用有關(guān)文件,逐項(xiàng)說明其功能和能力。
B.2.3.2文件
列出需移交給用戶的每種文件的名稱及內(nèi)容要點(diǎn)。
B.2.3.3服務(wù)
列出需向用戶提供的各項(xiàng)服務(wù),如培訓(xùn)安裝、維護(hù)和運(yùn)行支持等,應(yīng)逐項(xiàng)規(guī)定開始日期、所提供支持的級(jí)別和服務(wù)的期限。
B.2.3.4非移交的產(chǎn)品
說明開發(fā)集體應(yīng)向本單位交出但不必向用戶移交的產(chǎn)品(文件甚至某些程序)。
B.2.4驗(yàn)收標(biāo)準(zhǔn)
對(duì)于上述這些應(yīng)交出的產(chǎn)品和服務(wù),逐項(xiàng)說明或引用資料說明驗(yàn)收標(biāo)準(zhǔn)。
B.2.5完成項(xiàng)目的員遲用限
B.2.6本計(jì)劃的批準(zhǔn)者和批準(zhǔn)日期B.3實(shí)施計(jì)劃
B.3.1工作任務(wù)的分門與人員分工
對(duì)于項(xiàng)目開發(fā)中需完成的各項(xiàng)工作,從需求分析、設(shè)計(jì)、實(shí)現(xiàn)、測試直到維護(hù),包括文件的編制、審批、打印、分發(fā)工作,用戶培訓(xùn)工作,軟件安裝工作等,按層次進(jìn)行分解,指明每項(xiàng)任務(wù)的負(fù)責(zé)人和參加人員。
B.3.2接口人員
說明負(fù)責(zé)接口工作的人員及他們的職責(zé),包括:
a.負(fù)責(zé)本項(xiàng)目同用戶的接口人員;
b.負(fù)責(zé)本項(xiàng)目同本單位各管理機(jī)構(gòu),如合同計(jì)劃管理部門、財(cái)務(wù)部門、質(zhì)量管理部門等的接口人員;
c.負(fù)責(zé)本項(xiàng)目同各分合同負(fù)責(zé)單位的接口人員等。
B.3.3進(jìn)度
對(duì)于需求分析、設(shè)計(jì)、編碼實(shí)現(xiàn)、測試、移交、培訓(xùn)和安裝等工作,給出每項(xiàng)工作任務(wù)的預(yù)。定開始日期、完成日期及所需資源,規(guī)定各項(xiàng)工作任務(wù)完成的先后順序以及表征每項(xiàng)工作任務(wù)完成的標(biāo)志性事件(即所謂“里程碑”)。
B.3.4預(yù)算
逐項(xiàng)列出本開發(fā)項(xiàng)目所需要的勞務(wù)(包括人員的數(shù)量和時(shí)間)以及經(jīng)費(fèi)的預(yù)算(包括辦公費(fèi)、差旅費(fèi)、機(jī)時(shí)費(fèi)、資料費(fèi)、通訊設(shè)備和專用設(shè)備的租金等)和來源。
B.3.5關(guān)鍵問題
逐項(xiàng)列出能夠影響整個(gè)項(xiàng)目成敗的關(guān)鍵問題、技術(shù)難點(diǎn)和風(fēng)險(xiǎn),指出這些問題對(duì)項(xiàng)目的影響。
B.4支持條件
說明為支持本項(xiàng)目的開發(fā)所需要的各種條件和設(shè)施。
B.4.1計(jì)算機(jī)系統(tǒng)支持
逐項(xiàng)列出開發(fā)中和運(yùn)行時(shí)所需的計(jì)算機(jī)系統(tǒng)支持,包括計(jì)算機(jī)、外圍設(shè)備、通訊設(shè)備、模擬器、編譯(或匯編)程序、操作系統(tǒng)、數(shù)據(jù)管理程序包、數(shù)據(jù)存儲(chǔ)能力和測試支持能力等,逐項(xiàng)給出有關(guān)到貨日期、使用時(shí)間的要求。
B.4.2需由用戶承擔(dān)的工作
逐項(xiàng)列出需要用戶承擔(dān)的工作和完成期限。包括需由用戶提供的條件及提供時(shí)間。
B.4.3由外單位提供的條件
逐項(xiàng)列出需要外單位分合同承包者承擔(dān)的工作和完成的時(shí)間,包括需要由外單位提供的條件和提供的時(shí)間。
B.5專題計(jì)劃要點(diǎn)
說明本項(xiàng)目開發(fā)中需制訂的各個(gè)專題計(jì)劃(如分合同計(jì)劃、開發(fā)人員培訓(xùn)計(jì)劃、測試計(jì)劃、安全保密計(jì)劃、質(zhì)量保證計(jì)劃、配置管理計(jì)劃、用戶培訓(xùn)計(jì)劃、系統(tǒng)安裝計(jì)劃等)的要點(diǎn)。
附錄C軟件需求說明書的編寫提示C.1引言
C.1.1編寫目的
說明編寫這份軟件需求說明書的目的,指出預(yù)期的讀者。
C.1.2背景
說明:
a.待開發(fā)的軟件系統(tǒng)的名稱;
b.本項(xiàng)目的任務(wù)提出者、開發(fā)者、用戶及實(shí)現(xiàn)該軟件的計(jì)算中心或計(jì)算機(jī)網(wǎng)絡(luò);
C.該軟件系統(tǒng)同其他系統(tǒng)或其他機(jī)構(gòu)的基本的相互來往關(guān)系。
C.1.3定義
列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。
C.1.4參考資料
列出用得著的參考資料,如:
a.本項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同、上級(jí)機(jī)關(guān)的批文;
b.屬于本項(xiàng)目的其他已發(fā)表的文件;
c.本文件中各處引用的文件、資料、包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件資料的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位,說明能夠得到這些文件資料的來源。
C.2任務(wù)概述
C.2.1目標(biāo)
敘述該項(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)。如果所定義的產(chǎn)品是一個(gè)更大的系統(tǒng)的一個(gè)組成部分,則應(yīng)說明本產(chǎn)品與該系統(tǒng)中其他各組成部分之間的關(guān)系,為此可使用一張方框圖來說明該系統(tǒng)的組成和本產(chǎn)品同其他各部分的聯(lián)系和接口。|
C.2.2用戶的特點(diǎn)
列出本軟件的最終用戶的特點(diǎn),充分說明操作人員、維護(hù)人員的教育水平和技術(shù)專長,以及本軟件的預(yù)期使甩頻度。這些是軟件設(shè)計(jì)工作的重要約束
C.2.3假定和約束
列出進(jìn)行本軟件開發(fā)工作的假定和約束,例如經(jīng)費(fèi)限制、開發(fā)期限等。
C.3需求規(guī)定
C.3.1對(duì)功能的規(guī)定
用列表的方式(例如IPO表即輸入、處理、輸出表的形式),逐項(xiàng)定量和定性地?cái)⑹鰧?duì)軟件所提出的功能要求,說明輸入什么量、經(jīng)怎樣的處理、得到什么輸出,說明軟件應(yīng)支持的終端數(shù)和應(yīng)支持的并行操作的用戶數(shù)。
C.3.2對(duì)性能的規(guī)定
C.3.2.1精度
說明對(duì)該軟件的輸入、輸出數(shù)據(jù)精度的要求,可能包括傳輸過程中的精度。
C.3.2.2時(shí)間特性要求
說明對(duì)于該軟件的時(shí)間特性要求,如對(duì):
a.響應(yīng)時(shí)間;
b.更新處理時(shí)間;
c.?dāng)?shù)據(jù)的轉(zhuǎn)換和傳送時(shí)間;
d.解題時(shí)間;等的要求。
C.3.2.3靈活性
說明對(duì)該軟件的靈活性的要求,即當(dāng)需求發(fā)生某些變化時(shí),該軟件對(duì)這些變化的適應(yīng)能力,如:
a.操作方式上的變化;
b.運(yùn)行環(huán)境的變化;
c.同其他軟件的接口的變化;
d.精度和有效時(shí)限的變化;
e.計(jì)劃的變化或改進(jìn)。
對(duì)于為了提供這些靈活性而進(jìn)行的專門設(shè)計(jì)的部分應(yīng)該加以標(biāo)明。
C.3.3輸人輸出要求
解釋各輸入輸出數(shù)據(jù)類型,并逐項(xiàng)說明其媒體、格式、數(shù)值范圍、精度等。對(duì)軟件的數(shù)據(jù)輸出及必須標(biāo)明的控制輸出量進(jìn)行解釋并舉例,包括對(duì)硬拷貝報(bào)告(正常結(jié)果輸出、狀態(tài)輸出及異常輸出)以及圖形或顯示報(bào)告的描述。
C.3.4數(shù)據(jù)管理能力要求
說明需要管理的文卷和記錄的個(gè)數(shù)、表和文卷的大小規(guī)模,要按可預(yù)見的增長對(duì)數(shù)據(jù)及其分量的存儲(chǔ)要求作出估算。
C.3.5故障處理要求
列出可能的軟件、硬件故障以及對(duì)各項(xiàng)性能而言所產(chǎn)生的后果和對(duì)故障處理的要求。
C.3.6其他專門要求
如用戶單位對(duì)安全保密的要求,對(duì)使用方便的要求,對(duì)可維護(hù)性、可補(bǔ)充性、易讀性、可靠性、運(yùn)行環(huán)境可轉(zhuǎn)換性的特殊要求等。
C.4運(yùn)行環(huán)境規(guī)定
C.4.1設(shè)備
列出運(yùn)行該軟件所需要的硬設(shè)備。說明其中的新型設(shè)備及其專門功能,包括:
a.處理器型號(hào)及內(nèi)存容量;
b.外存容量、聯(lián)機(jī)或脫機(jī)、媒體及其存儲(chǔ)格式,設(shè)備的型號(hào)及數(shù)量;
c.輸入及輸出設(shè)備的型號(hào)和數(shù)量,聯(lián)機(jī)或脫機(jī);
d.?dāng)?shù)據(jù)通信設(shè)備的型號(hào)和數(shù)量;
e.功能鍵及其他專用硬件
C.4.2支持軟件
列出支持軟件,包括要用到的操作系統(tǒng)、編譯(或匯編)程序、測試支持軟件等。
C.4.3接口
說明該軟件同其他軟件之間的接口、數(shù)據(jù)通信協(xié)議等。
C.4.4控制
說明控制該軟件的運(yùn)行的方法和控制信號(hào),并說明這些控制信號(hào)的來源。附錄D數(shù)據(jù)要求說明書的編寫提示D.1引言
D.1.1編寫目的
說明編寫這份數(shù)據(jù)要求說明書的目的,指出預(yù)期的讀者。
D.1.2背景
說明:
a.待開發(fā)軟件系統(tǒng)的名稱;
b.列出本項(xiàng)目的任務(wù)提出者、開發(fā)者、用戶以及將運(yùn)行該項(xiàng)軟件的計(jì)算站(中心)或計(jì)算機(jī)網(wǎng)絡(luò)系統(tǒng)。
D.1.3定義
列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。
D.1.4參考資料
列出有關(guān)的參考資料,如:
a.本項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同,上級(jí)機(jī)關(guān)的批文;
b.屬于本項(xiàng)目的其他已發(fā)表文件;
c.本文件中各處引用的文件、資料,包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位。說明能夠得到這些文件資料的來源。
D.2數(shù)據(jù)的邏輯描述
對(duì)數(shù)據(jù)進(jìn)行邏輯描述時(shí)可把數(shù)據(jù)分為動(dòng)態(tài)數(shù)據(jù)和靜態(tài)數(shù)據(jù)。所謂靜態(tài)數(shù)據(jù),指在運(yùn)行過程中主要作為參考的數(shù)據(jù),它們在很長的一段時(shí)間內(nèi)不會(huì)變化,一般不隨運(yùn)行而改變。所謂動(dòng)態(tài)數(shù)據(jù).包括所有在運(yùn)行中要發(fā)生變化的數(shù)據(jù)以及在運(yùn)行中要輸入、輸出的數(shù)據(jù)。進(jìn)行描述時(shí)應(yīng)把各數(shù)據(jù)元素邏輯地分成若干組,列如函數(shù)、源數(shù)據(jù)或?qū)τ谄鋺?yīng)用更為恰當(dāng)?shù)倪壿嫹纸M。給出每一數(shù)據(jù)元的名稱(包括縮寫和代碼)、定義(或物理意義)度量單位、值域、格式和類型等有關(guān)信息。
D.2.1靜態(tài)數(shù)據(jù)
列出所有作為控制或參考用的靜態(tài)數(shù)據(jù)元素。
D.2.2動(dòng)態(tài)輸人數(shù)據(jù)
列出動(dòng)態(tài)輸入數(shù)據(jù)元素(包括在常規(guī)運(yùn)行中或聯(lián)機(jī)操作中要改變的數(shù)據(jù))。
D.2.3動(dòng)態(tài)輸出數(shù)據(jù)
列出動(dòng)態(tài)輸出數(shù)據(jù)元素(包括在常規(guī)運(yùn)行中或聯(lián)機(jī)操作中要改變的數(shù)據(jù))。
D.2.4內(nèi)部生成數(shù)據(jù)
列出向用戶或開發(fā)單位中的維護(hù)調(diào)試人員提供的內(nèi)部生成數(shù)據(jù)。
D.2.5數(shù)據(jù)約定
說明對(duì)數(shù)據(jù)要求的制約。逐條列出對(duì)進(jìn)一步擴(kuò)充或使用方面的考慮而提出的對(duì)數(shù)據(jù)要求的限制(容量、文卷、記錄和數(shù)據(jù)元的個(gè)數(shù)的最大值)。對(duì)于在設(shè)計(jì)和開發(fā)中確定是臨界性的限制更要明確指出。
D.3.?dāng)?shù)據(jù)的采集
D.3.1要求和范圍
按數(shù)據(jù)元的邏輯分組來說明數(shù)據(jù)采集的要求和范圍,指明數(shù)據(jù)的采集方法,說明數(shù)據(jù)采集工作的承擔(dān)者是用戶還是開發(fā)者。具體的內(nèi)容包括:
a.輸入數(shù)據(jù)的來源,例如是單個(gè)操作員、數(shù)據(jù)輸入站,專業(yè)的數(shù)據(jù)輸入公司或它們的一個(gè)分組;
b.?dāng)?shù)據(jù)輸入(指把數(shù)據(jù)輸入處理系統(tǒng)內(nèi)部)所用的媒體和硬設(shè)備。如果只有指定的輸入點(diǎn)的輸入才是合法的,則必須對(duì)此加以說明;
c.接受者說明輸出數(shù)據(jù)的接受者;
d.輸出數(shù)據(jù)的形式和設(shè)備列出輸出數(shù)據(jù)的形式和硬設(shè)備。無論接受者將接收到的數(shù)據(jù)是打印輸出,還是CRT上的一組字符、一幀圖形,或一聲警鈴,或向開關(guān)線圈提供的一個(gè)電脈沖,或常用介質(zhì)如磁盤、磁帶、穿孔卡片等,均應(yīng)具體說明;
e.?dāng)?shù)據(jù)值的范圍給出每一個(gè)數(shù)據(jù)元的合法值的范圍;
f.量綱給出數(shù)字的度量單位、增量的步長、零點(diǎn)的定標(biāo)等。在數(shù)據(jù)是非數(shù)字量的情況下,要給出每一種合法值的形式和含意;
g.更新和處理的頻度給出預(yù)定的對(duì)輸入數(shù)據(jù)的更新和處理的頻度。如果數(shù)據(jù)的輸入是隨機(jī)的,應(yīng)給出更新處理的頻度的平均值,或變化情況的某種其他度量。
D.3.2輸人的承擔(dān)者
說明預(yù)定的對(duì)數(shù)據(jù)輸入工作的承擔(dān)者。如果輸入數(shù)據(jù)同某一接口軟件有關(guān),還應(yīng)說明該接口軟件的來源。
D.3.3預(yù)處理
對(duì)數(shù)據(jù)的采集和預(yù)處理過程提出專門的規(guī)定,包括適合應(yīng)用的數(shù)據(jù)格式、預(yù)定的數(shù)據(jù)通信媒體和對(duì)輸入的時(shí)間要求等。對(duì)于需經(jīng)模擬轉(zhuǎn)換或數(shù)字轉(zhuǎn)換處理的數(shù)據(jù)量,要給出轉(zhuǎn)換方法和轉(zhuǎn)換因子等有關(guān)信息,以便軟件系統(tǒng)使用這些數(shù)據(jù)。
D.3.4影響
說明這些數(shù)據(jù)要求對(duì)于設(shè)備、軟件、用戶、開發(fā)單位所可能產(chǎn)生的影響,例如要求用戶單位增設(shè)某個(gè)機(jī)構(gòu)等。附錄E概要設(shè)計(jì)說明書的編寫提示E.1引言
E.1.1編寫目的
說明編寫這份概要設(shè)計(jì)說明書的目的,指出預(yù)期的讀者。
E.1.2背景
說明:
a.待開發(fā)軟件系統(tǒng)的名稱;
b.列出此項(xiàng)目的任務(wù)提出者、開發(fā)者、用戶以及將運(yùn)行該軟件的計(jì)算站(中心)。
E.1.3定義
列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。
E.1.4參考資料
列出有關(guān)的參考文件,如:
a.本項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同,上級(jí)機(jī)關(guān)的批文;
b.屬于本項(xiàng)目的其他已發(fā)表文件;
c.本文件中各處引用的文件、資料,包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位,說明能夠得到這些文件資料的來源。
E.2總體設(shè)計(jì)
E.2.1需求規(guī)定
說明對(duì)本系統(tǒng)的主要的輸入輸出項(xiàng)目、處理的功能性能要求,詳細(xì)的說明可參見附錄C。
E.2.2運(yùn)行環(huán)境
簡要地說明對(duì)本系統(tǒng)的運(yùn)行環(huán)境(包括硬件環(huán)境和支持環(huán)境)的規(guī)定,詳細(xì)說明參見附錄C。
E.2.3基本設(shè)計(jì)概念和處理流程
說明本系統(tǒng)的基本設(shè)計(jì)概念和處理流程,盡量使用圖表的形式。
E.2.4結(jié)構(gòu)
用一覽表及框圖的形式說明本系統(tǒng)的系統(tǒng)元素(各層模塊、子程序、公用程序等)的劃分,扼要說明每個(gè)系統(tǒng)元素的標(biāo)識(shí)符和功能,分層次地給出各元素之間的控制與被控制關(guān)系.
E.2.5功能器求與程序的關(guān)系
本條用一張如下的矩陣圖說明各項(xiàng)功能需求的實(shí)現(xiàn)同各塊程序的分配關(guān)系:
E.2.6人工處理過程
說明在本軟件系統(tǒng)的工作過程中不得不包含的人工處理過程(如果有的話)。
E.2.7尚未問決的問題
說明在概要設(shè)計(jì)過程中尚未解決而設(shè)計(jì)者認(rèn)為在系統(tǒng)完成之前必須解決的各個(gè)問題。
E.3接口設(shè)計(jì)
E.3.1用戶接口
說明將向用戶提供的命令和它們的語法結(jié)構(gòu),以及軟件的回答信息。
E.3.2外部接口
說明本系統(tǒng)同外界的所有接口的安排包括軟件與硬件之間的接口、本系統(tǒng)與各支持軟件之間的接口關(guān)系。
E.3.3內(nèi)部接口
說明本系統(tǒng)之內(nèi)的各個(gè)系統(tǒng)元素之間的接口的安排。
E.4運(yùn)行設(shè)計(jì)
E.4.1運(yùn)行模塊組合
說明對(duì)系統(tǒng)施加不同的外界運(yùn)行控制時(shí)所引起的各種不同的運(yùn)行模塊組合,說明每種運(yùn)行所歷經(jīng)的內(nèi)部模塊和支持軟件。
E.4.2運(yùn)行控制
說明每一種外界的運(yùn)行控制的方式方法和操作步驟。
E.4.3運(yùn)行時(shí)間
說明每種運(yùn)行模塊組合將占用各種資源的時(shí)間。
E.5系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)
E.5.1邏輯結(jié)構(gòu)設(shè)計(jì)要點(diǎn)
給出本系統(tǒng)內(nèi)所使用的每個(gè)數(shù)據(jù)結(jié)構(gòu)的名稱、標(biāo)識(shí)符以及它們之中每個(gè)數(shù)據(jù)項(xiàng)、記錄、文卷和系的標(biāo)識(shí)、定義、長度及它們之間的層次的或表格的相互關(guān)系。
E.5.2物理結(jié)構(gòu)設(shè)計(jì)要點(diǎn)
給出本系統(tǒng)內(nèi)所使用的每個(gè)數(shù)據(jù)結(jié)構(gòu)中的每個(gè)數(shù)據(jù)項(xiàng)的存儲(chǔ)要求,訪問方法、存取單位、存取的物理關(guān)系(索引、設(shè)備、存儲(chǔ)區(qū)域)、設(shè)計(jì)考慮和保密條件。
E.5.3數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系
說明各個(gè)數(shù)據(jù)結(jié)構(gòu)與訪問這些數(shù)據(jù)結(jié)構(gòu)的形式:
E.6系統(tǒng)出錯(cuò)處理設(shè)計(jì)
E.6.1出錯(cuò)信息
用一覽表的方式說朗每種可能的出錯(cuò)或故障情況出現(xiàn)時(shí),系統(tǒng)輸出信息的形式、含意及處理方法。
E.6.2補(bǔ)救措施
說明故障出現(xiàn)后可能采取的變通措施,包括:
a.后備技術(shù)說明準(zhǔn)備采用的后備技術(shù),當(dāng)原始系統(tǒng)數(shù)據(jù)萬一丟失時(shí)啟用的副本的建立和啟動(dòng)的技術(shù),例如周期性地把磁盤信息記錄到磁帶上去就是對(duì)于磁盤媒體的一種后備技術(shù);
b.降效技術(shù)說明準(zhǔn)備采用的后備技術(shù),使用另一個(gè)效率稍低的系統(tǒng)或方法來求得所需結(jié)果的某些部分,例如一個(gè)自動(dòng)系統(tǒng)的降效技術(shù)可以是手工操作和數(shù)據(jù)的人工記錄;
c.恢復(fù)及再啟動(dòng)技術(shù)說明將使用的恢復(fù)再啟動(dòng)技術(shù),使軟件從故障點(diǎn)恢復(fù)執(zhí)行或使軟件從頭開始重新運(yùn)行的方法。E.6.3系統(tǒng)維護(hù)設(shè)計(jì)
說明為了系統(tǒng)維護(hù)的方便而在程序內(nèi)部設(shè)計(jì)中作出的安排,包括在程序中專門安排用于系統(tǒng)的檢查與維護(hù)的檢測點(diǎn)和專用模塊。各個(gè)程序之間的對(duì)應(yīng)關(guān)系,可采用如下的矩陣圖的形式;
附錄F詳細(xì)設(shè)計(jì)說明書的編寫提示F.1引言
F.1.1編寫目的
說明編寫這份詳細(xì)設(shè)計(jì)說明書的目的,指出預(yù)期的讀者。
F.1.2背景
說明:
a.待開發(fā)軟件系統(tǒng)的名稱;
b.本項(xiàng)目的任務(wù)提出者、開發(fā)者、用戶和運(yùn)行該程序系統(tǒng)的計(jì)算中心。
F.1.3定義
列出本文件中用到專門術(shù)語的定義和外文首字母組詞的原詞組。
F.1.4參考資料
列出有關(guān)的參考資料,如:
a.本項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同、上級(jí)機(jī)關(guān)的批文;
b.屬于本項(xiàng)目的其他已發(fā)表的文件;
c.本文件中各處引用到的文件資料,包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位,說明能夠取得這些文件的來源。
F.2程序系統(tǒng)的結(jié)構(gòu)
用一系列圖表列出本程序系統(tǒng)內(nèi)的每個(gè)程序(包括每個(gè)模塊和子程序)的名稱、標(biāo)識(shí)符和它們之間的層次結(jié)構(gòu)關(guān)系。
F.3程序1(標(biāo)識(shí)符)設(shè)計(jì)說明
從本章開始,逐個(gè)地給出各個(gè)層次中的每個(gè)程序的設(shè)計(jì)考慮。以下給出的提綱是針對(duì)一般情況的。對(duì)于一個(gè)具體的模塊,尤其是層次比較低的模塊或子程序,其很多條目的內(nèi)容往往與它所隸屬的上一層模塊的對(duì)應(yīng)條目的內(nèi)容相同,在這種情況下,只要簡單地說明這一點(diǎn)即可。
F.3.1程序描述
給出對(duì)該程序的簡要描述,主要說明安排設(shè)計(jì)本程序的目的意義,并且,還要說明本程序的特點(diǎn)(如是常駐內(nèi)存還是非常駐?是否子程序?是可重人的還是不可重人的?有無覆蓋要求?是順序處理還是并發(fā)處理卜…..等)。
F.3.2功能
說明該程序應(yīng)具有的功能,可采用IPO圖(即輸入一處理一輸出圖)的形式。
F.3.3性能
說明對(duì)該程序的全部性能要求,包括對(duì)精度、靈活性和時(shí)間特性的要求。
F.3.4輸人項(xiàng)
給出對(duì)每一個(gè)輸入項(xiàng)的特性,包括名稱、標(biāo)識(shí)、數(shù)據(jù)的類型和格式、數(shù)據(jù)值的有效范圍、輸入的方式。數(shù)量和頻度、輸入媒體、輸入數(shù)據(jù)的來源和安全保密條件等等。
F.3.5輸出項(xiàng)
給出對(duì)每一個(gè)輸出項(xiàng)的特性,包括名稱、標(biāo)識(shí)、數(shù)據(jù)的類型和格式,數(shù)據(jù)值的有效范圍,輸出的形式、數(shù)量和頻度,輸出媒體、對(duì)輸出圖形及符號(hào)的說明、安全保密條件等等。
F.3.6算法
詳細(xì)說明本程序所選用的算法,具體的計(jì)算公式和計(jì)算步驟。
F.3.7流程邏輯
用圖表(例如流程圖、判定表等)輔以必要的說明來表示本程序的邏輯流程。
F.3.8接口
用圖的形式說明本程序所隸屬的上一層模塊及隸屬于本程序的下一層模塊、子程序,說明參數(shù)賦值和調(diào)用方式,說明與本程序相直接關(guān)聯(lián)的數(shù)據(jù)結(jié)構(gòu)(數(shù)據(jù)庫、數(shù)據(jù)文卷)。
F.3.9存儲(chǔ)分配
根據(jù)需要,說明本程序的存儲(chǔ)分配。
F.3.10注釋設(shè)計(jì)
說明準(zhǔn)備在本程序中安排的注釋,如:
a.加在模塊首部的注釋;
b.加在各分枝點(diǎn)處的注釋;對(duì)各變量的功能、范圍、缺省條件等所加的注釋;
d.對(duì)使用的邏輯所加的注釋等等。
F.3.11限制條件
說明本程序運(yùn)行中所受到的限制條件。
F.3.12測試計(jì)劃
說明對(duì)本程序進(jìn)行單體測試的計(jì)劃,包括對(duì)測試的技術(shù)要求、輸入數(shù)據(jù)、預(yù)期結(jié)果、進(jìn)度安排、人員職責(zé)、設(shè)備條件驅(qū)動(dòng)程序及樁模塊等的規(guī)定。
F.3.13尚未解決的問題
說明在本程序的設(shè)計(jì)中尚未解決而設(shè)計(jì)者認(rèn)為在軟件完成之前應(yīng)解決的問題。
F.4程序2(標(biāo)識(shí)符)設(shè)計(jì)說明
用類似F.3的方式,說明第2個(gè)程序乃至第N個(gè)程序的設(shè)計(jì)考慮。
......
附錄G數(shù)據(jù)庫設(shè)計(jì)說明書的編寫提示G.1引言
G.1.1編寫目的
說明編寫這份數(shù)據(jù)庫設(shè)計(jì)說明書的目的,指出預(yù)期的讀者。
G.1.2背景
說明:
a.說明待開發(fā)的數(shù)據(jù)庫的名稱和使用此數(shù)據(jù)庫的軟件系統(tǒng)的名稱;
b.列出該軟件系統(tǒng)開發(fā)項(xiàng)目的任務(wù)提出者、用戶以及將安裝該軟件和這個(gè)數(shù)據(jù)庫的計(jì)算站(中心)。
G.1.3定義
列出本文件中用到的專門術(shù)語的定義、外文首字母組詞的原詞組。
G.1.4參考資料
列出有關(guān)的參考資料:
a.本項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同、上級(jí)機(jī)關(guān)批文;
b.屬于本項(xiàng)目的其他已發(fā)表的文件;
c.本文件中各處引用到的文件資料,包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。
列出這些文件的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位,說明能夠取得這些文件的來源。
G.2外部設(shè)計(jì)
G.2.1標(biāo)識(shí)符和狀態(tài)
聯(lián)系用途,詳細(xì)說明用于唯一地標(biāo)識(shí)該數(shù)據(jù)庫的代碼、名稱或標(biāo)識(shí)符,附加的描述性信息亦要給出。如果該數(shù)據(jù)庫屬于尚在實(shí)驗(yàn)中、尚在測試中或是暫時(shí)使用的,則要說明這一特點(diǎn)及其有效時(shí)間范圍。
G.2.2使用它的程序
列出將要使用或訪問此數(shù)據(jù)庫的所有應(yīng)用程序,對(duì)于這些應(yīng)用程序的每一個(gè),給出它的名稱和版本號(hào)。
G.2.3約定
陳述一個(gè)程序員或一個(gè)系統(tǒng)分析員為了能使用此數(shù)據(jù)庫而需要了解的建立標(biāo)號(hào)、標(biāo)識(shí)的約定,例如用于標(biāo)識(shí)數(shù)據(jù)庫的不同版本的約定和用于標(biāo)識(shí)庫內(nèi)各個(gè)文卷、、記錄、數(shù)據(jù)項(xiàng)的命名約定等。
G.2.4專門指導(dǎo)
向準(zhǔn)備從事此數(shù)據(jù)庫的生成、從事此數(shù)據(jù)庫的測試、維護(hù)人員提供專門的指導(dǎo),例如將被送入數(shù)據(jù)庫的數(shù)據(jù)的格式和標(biāo)準(zhǔn)、送入數(shù)據(jù)庫的操作規(guī)程和步驟,用于產(chǎn)生、修改、
溫馨提示
- 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請(qǐng)下載最新的WinRAR軟件解壓。
- 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請(qǐng)聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
- 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁內(nèi)容里面會(huì)有圖紙預(yù)覽,若沒有圖紙預(yù)覽就沒有圖紙。
- 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
- 5. 人人文庫網(wǎng)僅提供信息存儲(chǔ)空間,僅對(duì)用戶上傳內(nèi)容的表現(xiàn)方式做保護(hù)處理,對(duì)用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對(duì)任何下載內(nèi)容負(fù)責(zé)。
- 6. 下載文件中如有侵權(quán)或不適當(dāng)內(nèi)容,請(qǐng)與我們聯(lián)系,我們立即糾正。
- 7. 本站不保證下載資源的準(zhǔn)確性、安全性和完整性, 同時(shí)也不承擔(dān)用戶因使用這些下載資源對(duì)自己和他人造成任何形式的傷害或損失。
最新文檔
- 民族團(tuán)結(jié)進(jìn)步年工作總結(jié)
- 鋼結(jié)構(gòu)柱梁制作工藝流程
- 工業(yè)廢水處理工職業(yè)技能競賽參與考核試卷及答案
- 2025年職業(yè)技能鑒定考試(電力行業(yè)油務(wù)員-初級(jí))歷年參考題庫含答案
- 酒店餐飲部年度工作總結(jié)
- 2025年工會(huì)工作個(gè)人總結(jié)
- 2025年企業(yè)培訓(xùn)師(高級(jí))企業(yè)社會(huì)責(zé)任倫理道德理論知識(shí)試卷及答案
- 通風(fēng)與空調(diào)系統(tǒng)調(diào)試方案
- 建設(shè)工程施工合同糾紛要素式起訴狀模板完整版無缺失
- 信息與信息技術(shù)的
- 秦腔課件教學(xué)
- DB51-T 1959-2022 中小學(xué)校學(xué)生宿舍(公寓)管理服務(wù)規(guī)范
- 水利工程施工監(jiān)理規(guī)范(SL288-2014)用表填表說明及示例
- 妊娠合并膽汁淤積綜合征
- 河南省安陽市滑縣2024-2025學(xué)年高二數(shù)學(xué)上學(xué)期期末考試試題文
- 新疆維吾爾自治區(qū)普通高校學(xué)生轉(zhuǎn)學(xué)申請(qǐng)(備案)表
- 內(nèi)鏡中心年終總結(jié)
- 園林苗木容器育苗技術(shù)
- 陜西省2023-2024學(xué)年高一上學(xué)期新高考解讀及選科簡單指導(dǎo)(家長版)課件
- 兒科學(xué)熱性驚厥課件
- 《高職應(yīng)用數(shù)學(xué)》(教案)
評(píng)論
0/150
提交評(píng)論