00計(jì)算機(jī)軟件產(chǎn)品開發(fā)文件編制指南11_第1頁
00計(jì)算機(jī)軟件產(chǎn)品開發(fā)文件編制指南11_第2頁
00計(jì)算機(jī)軟件產(chǎn)品開發(fā)文件編制指南11_第3頁
已閱讀5頁,還剩22頁未讀, 繼續(xù)免費(fèi)閱讀

下載本文檔

版權(quán)說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請進(jìn)行舉報(bào)或認(rèn)領(lǐng)

文檔簡介

1、00 計(jì)算機(jī)軟件產(chǎn)品開發(fā)文件編制指南 編制指南河南雪城軟件2021年2月名目1. 引言 51.1目的 51.2范疇 51.3文件的使用者 62. 文件的編制指導(dǎo)72.1軟件生存周期與各種文件的編制72.2文件編制中的考慮因素 文件的讀者 9重復(fù)性 靈活性 應(yīng)編制的文件種類9文件的詳細(xì)程度 文件的擴(kuò)展10節(jié)的擴(kuò)張與縮并 程序設(shè)計(jì)的表現(xiàn)形式 文件的表現(xiàn)形式 文件的其他種類 123. 文件編制的治理工作 12 3.1文件的形成 12 3.2文件的分類與標(biāo)識123.3文件的操縱 13 3.4文件的修改治理 144. 各種文件的內(nèi)容要求 15 4.1可行性研究報(bào)告 15 4.2工程開發(fā)打算 17 4.3

2、軟件需求講明書 18 4.4數(shù)據(jù)要求講明書 19 4.5概要設(shè)計(jì)講明書 204.6詳細(xì)設(shè)計(jì)講明書214.7數(shù)據(jù)庫設(shè)計(jì)講明書4.8用戶手冊 234.9操作手冊 244.10模塊開發(fā)卷宗254.11測試打算及設(shè)計(jì)254.12測試分析報(bào)告264.13開發(fā)進(jìn)度月報(bào)274.14開發(fā)總結(jié)報(bào)告28附錄 :產(chǎn)品文件體系28221. 引言1.1 目的一項(xiàng)運(yùn)算機(jī)軟件的籌劃、研制及實(shí)現(xiàn),構(gòu)成一個(gè)軟件開發(fā)工程。一個(gè) 軟件開發(fā)工程的進(jìn)行,一樣需要在人力和自動化資源等方面作重大的投資。 為了保證工程開發(fā)的成功,最經(jīng)濟(jì)地花費(fèi)這些投資,同時(shí)便于運(yùn)行和保護(hù), 在開發(fā)工作的每一時(shí)期,都需要編制一定的文件。這些文件連同運(yùn)算機(jī)程 序

3、及數(shù)據(jù)一起,構(gòu)成為運(yùn)算機(jī)軟件。文件是運(yùn)算機(jī)軟件中不可缺少的組成 局部,它的作用是:a. 作為開發(fā)人員在一定時(shí)期內(nèi)的工作成果和終止標(biāo)志;b. 向治理人員提供軟件開發(fā)過程中的進(jìn)展和情形,把軟件開發(fā)過程中的一些“不可見的事物轉(zhuǎn)換成“可見的文字資料,以便治理人員在各 個(gè)時(shí)期檢查開發(fā)打算的實(shí)施進(jìn)展,使之能夠判定原定目標(biāo)是否已到達(dá),還 將連續(xù)耗用資源的種類和數(shù)量;c. 記錄開發(fā)過程中的技術(shù)信息,便于和諧以后的軟件開發(fā)、使用和修 改;d. 提供對軟件的有關(guān)運(yùn)行、保護(hù)和培訓(xùn)的信息,便于治理人員、開發(fā) 人員、操作人員和用戶之間相互了解彼此的工作;e. 向潛在用戶報(bào)導(dǎo)軟件的功能和性能,使他們能判定該軟件能否效勞

4、于自己的需要。換言之,本指南認(rèn)為:文件的編制必須適應(yīng)運(yùn)算機(jī)軟件整個(gè)生存周期 的需要。運(yùn)算機(jī)軟件所包含的文件有兩類:一類是開發(fā)過程中填寫的各種圖表, 可稱之為工作表格;另一類那么是應(yīng)編制的技術(shù)資料或技術(shù)治理資料,可稱 之為文件。本指南規(guī)定軟件文件的編制形式,并提供對這些規(guī)定的講明。 本指南的目的是使得所編制的軟件文件確實(shí)能夠起到軟件文件應(yīng)該發(fā)揮的 作用。1.2 范疇本指南建議,在一項(xiàng)運(yùn)算機(jī)軟件的開發(fā)過程中,一樣地講,應(yīng)該產(chǎn)生 十四種文件。這十四種文件是:可行性研究報(bào)告; 工程開發(fā)打算; 軟件需求講明書; 數(shù)據(jù)要求講明書; 概要設(shè)計(jì)講明書; 詳細(xì)設(shè)計(jì)講明書; 數(shù)據(jù)庫設(shè)計(jì)講明書; 用戶手冊; 操作手

5、冊; 模塊開發(fā)卷宗; 測試打算; 測試分析報(bào)告; 開發(fā)進(jìn)度月報(bào); 工程開發(fā)總結(jié)報(bào)告。 本指南將給出開發(fā)過程中建議產(chǎn)生的這十四種文件的編制指導(dǎo),同時(shí), 本指南也是這十四種文件的編寫質(zhì)量的檢驗(yàn)準(zhǔn)那么。1.3 文件的使用者 關(guān)于使用文件的人員而言,他們所關(guān)心的文件的種類,隨他們所承當(dāng) 的工作而異。治理人員: 可行性研究報(bào)告, 工程開發(fā)打算, 模塊開發(fā)卷宗, 開發(fā)進(jìn)度月報(bào), 工程開發(fā)總結(jié)報(bào)告; 開發(fā)和測試人員: 可行性研究報(bào)告,工程開發(fā)打算,軟件需求講明書,數(shù)據(jù)要求講明書,概要設(shè)計(jì)講明書,詳細(xì)設(shè)計(jì)講明書,數(shù)據(jù)庫設(shè)計(jì)講明書,測試打算,測試分析報(bào)告;保護(hù)人員:設(shè)計(jì)講明書,測試分析報(bào)告,模塊開發(fā)卷宗;用戶:

6、用戶手冊,操作手冊。盡管本指南提出了在軟件開發(fā)中文件編制的要求,但并不意味著這些 文件都必須交給用戶。一項(xiàng)軟件的用戶應(yīng)該得到的文件的種類由供給者與 用戶之間簽訂的合同規(guī)定。2. 文件的編制指導(dǎo)2.1 軟件生存周期與各種文件的編制 一項(xiàng)運(yùn)算機(jī)軟件,從顯現(xiàn)一個(gè)構(gòu)思之日起,通過這項(xiàng)軟件開發(fā)成功投 入使用,直到最后決定停止使用,并被另一項(xiàng)軟件代替之時(shí)止,被認(rèn)為是 該軟件的一個(gè)生存周期。一樣地講那個(gè)軟件生存周期能夠分成以下六個(gè)時(shí) 期:1、可行性與打算研究時(shí)期2、需求分析時(shí)期3、設(shè)計(jì)時(shí)期4、實(shí)現(xiàn)時(shí)期5、測試時(shí)期6、運(yùn)行與保護(hù)時(shí)期在可行性研究與打算時(shí)期內(nèi),要確定該軟件的開發(fā)目標(biāo)和總的要求, 要進(jìn)行可行性分析

7、、投資一收益分析、制訂開發(fā)打算,并完成應(yīng)編制的文 件。在需求分析時(shí)期內(nèi),由系統(tǒng)分析人員對被設(shè)計(jì)的系統(tǒng)進(jìn)行系統(tǒng)分析, 確定對該軟件的各項(xiàng)功能、性能需求和設(shè)計(jì)約束,確定對文件編制的要求, 作為本時(shí)期工作的結(jié)果,一樣地講,軟件需求講明書、數(shù)據(jù)要求講明書應(yīng) 該編寫出來。在設(shè)計(jì)時(shí)期內(nèi),系統(tǒng)設(shè)計(jì)人員和程序設(shè)計(jì)人員應(yīng)該在反復(fù)明白得軟件 需求的根底上,提出多個(gè)設(shè)計(jì),分析每個(gè)設(shè)計(jì)能履行的功能并進(jìn)行相互比 較,最后確定一個(gè)設(shè)計(jì),包括該軟件的結(jié)構(gòu)、模塊的劃分、功能的分配以 及處理流程。在被設(shè)計(jì)系統(tǒng)比擬復(fù)雜的情形下,設(shè)計(jì)時(shí)期應(yīng)分解成概要設(shè) 計(jì)時(shí)期和詳細(xì)設(shè)計(jì)時(shí)期兩個(gè)步驟。在一樣情形下,應(yīng)完成的文件包括:概 要設(shè)計(jì)講明書

8、、詳細(xì)設(shè)計(jì)講明書。在實(shí)現(xiàn)時(shí)期內(nèi),要完成源程序的編碼、編譯或匯編和排錯(cuò)調(diào)試, 得到無語法錯(cuò)的程序清單,要開始編寫模塊開發(fā)卷宗,同時(shí)要完成用戶手 冊、操作手冊等面向用戶的文件的編寫工作,還要完成測試打算的編制。在測試時(shí)期,該程序?qū)⒈蝗娴販y試,已編制的文件將被檢查批閱。 一樣要完成模塊開發(fā)卷宗和測試分析報(bào)告,作為開發(fā)工作的終止,所生產(chǎn) 的程序、文件以及開發(fā)工作本身將逐項(xiàng)被評判,最后寫出工程開發(fā)總結(jié)報(bào) 告。在整個(gè)開發(fā)過程中即前五個(gè)時(shí)期中 ,開發(fā)集體要按月編寫開發(fā)進(jìn)度 月報(bào)。在運(yùn)行和保護(hù)時(shí)期,軟件將在運(yùn)行使用中持續(xù)地被保護(hù),按照新提出 的需求進(jìn)行必要而且可能的擴(kuò)充和刪改。關(guān)于一項(xiàng)軟件而言,其生存周期各

9、時(shí)期與各種文件編寫工作的關(guān)系可 見表互,其中有些文件的編寫工作可能要在假設(shè)干個(gè)時(shí)期中連續(xù)進(jìn)行。表 1 軟件生存周期各時(shí)期中的文件編制2.2 文件編制中的考慮因素文件編制是一個(gè)持續(xù)努力的工作過程。是一個(gè)從形成最初輪廓,經(jīng)反 復(fù)檢查和修改,直到程序和文件正式交付使用的完整過程。其中每一步都 要求工作人員做出專門大努力。要保證文件編制的質(zhì)量,要表達(dá)每個(gè)開發(fā) 工程的特點(diǎn),也要注意不要花太多的人力。為此,編制中要考慮如下各項(xiàng) 因素。2.2.1 文件的讀者 每一種文件都具有特定的讀者。這些讀者包括個(gè)人或小組、軟件開發(fā) 單位的成員或社會上的公眾、從事軟件工作的技術(shù)人員、治理人員或領(lǐng)導(dǎo) 干部。他們期待著使用這

10、些文件的內(nèi)容來進(jìn)行工作,例如設(shè)計(jì)、編寫程序、 測試、使用、保護(hù)或進(jìn)行打算治理。因此,這些文件的作者必須了解自己 的讀者,這些文件的編寫必須注意適應(yīng)自己的特定讀者的水平、特點(diǎn)和要 求。2.2.2 重復(fù)性 本指南第二篇中將列出的這十四種文件的內(nèi)容要求中,明顯存在某些 重復(fù)。較明顯的重復(fù)有兩類。引言是每一種文件都要包含的內(nèi)容,以向讀 者提供總的梗概。第二類明顯的重復(fù)是各種文件中的講明局部,如對功能 性能的講明、對輸入和輸出的描述、系統(tǒng)中包含的設(shè)備等。這是為了方便 每種文件各自的讀者,每種產(chǎn)品文件應(yīng)該自成體系,盡量幸免讀一種文件 時(shí)又不得不去參考另一種文件。因此,在每一種文件里,有關(guān)引言、講明 等同其

11、他文件相重復(fù)的局部,在行文上、在所用的術(shù)語上、在詳細(xì)的程度 上,依舊應(yīng)該有一些差不,以適應(yīng)各種文件的不同讀者的需要。2.2.3 靈活性鑒于軟件開發(fā)是具有制造性的腦力勞動,也鑒于不同軟件在規(guī)模上和 復(fù)雜程度上差不極大,本指南認(rèn)為在文件編制工作中應(yīng)承諾一定的靈活性。 這種靈活性表現(xiàn)在如下各款。應(yīng)編制的文件種類盡管本指南認(rèn)為在一樣情形下,一項(xiàng)軟件的開發(fā)過程中,應(yīng)產(chǎn)生的文 件有十四種,然而針對一項(xiàng)具體的軟件開發(fā)工程,有時(shí)不必編制這么多的 文件,能夠把幾種文件合并成一種。一樣地講,當(dāng)工程的規(guī)模、復(fù)雜性和 成敗風(fēng)險(xiǎn)增大時(shí),文件編制的范疇、治理手續(xù)和詳細(xì)程度將隨之增加。反 之,那么可適當(dāng)減少。為了恰當(dāng)?shù)匕盐?/p>

12、這種靈活性,本指南要求貫徹分工負(fù) 責(zé)的原那么,這意味著:a. 個(gè)軟件開發(fā)單位的領(lǐng)導(dǎo)機(jī)構(gòu)應(yīng)該按照本單位經(jīng)營承包的應(yīng)用軟件的專業(yè)領(lǐng)域和本單位的治理能力,制定一個(gè)對文件編制要求的實(shí)施規(guī)定, 要緊是:在不同的條件下,應(yīng)該形成哪些文件?這些文件的詳細(xì)程度?該 開發(fā)單位的每一個(gè)工程負(fù)責(zé)人,必須認(rèn)真執(zhí)行那個(gè)實(shí)施規(guī)定。這種規(guī)定的 兩個(gè)例子可參考本指南的附錄o參考件;b. 關(guān)于一個(gè)具體的應(yīng)用軟件工程,工程負(fù)責(zé)人應(yīng)按照上述實(shí)施規(guī)定,確定一個(gè)文件編制打算,要緊包括:1、應(yīng)該編制哪幾種文件,詳細(xì)程度如何?2、各個(gè)文件的編制負(fù)責(zé)人和進(jìn)度要求;3、審查、批準(zhǔn)的負(fù)責(zé)人和時(shí)刻進(jìn)度安排;4、在開發(fā)時(shí)期內(nèi),各文件的保護(hù)、修改和治

13、理的負(fù)責(zé)人,以及批準(zhǔn)手 續(xù)。5、每項(xiàng)工作必須落實(shí)到人。6、那個(gè)文件編制打確實(shí)是整個(gè)開發(fā)打算的重要組成局部;c. 有關(guān)的設(shè)計(jì)人員那么必須嚴(yán)格執(zhí)行那個(gè)文件編制打算。文件的詳細(xì)程度從同一份提綱起草的文件的篇幅大小往往不同,能夠少到幾頁,也能 夠長達(dá)幾百頁。關(guān)于這種差不本指南是承諾的。其詳細(xì)程度取決于任務(wù)的 規(guī)模、復(fù)雜性和工程負(fù)責(zé)人對該軟件的開發(fā)過程及運(yùn)行環(huán)與所需要的詳細(xì) 程度的判定。文件的擴(kuò)展當(dāng)被開發(fā)系統(tǒng)的規(guī)模專門大例如源碼超過一百萬行時(shí),一種文件 能夠分成幾卷編寫,能夠按其每一個(gè)系統(tǒng)分不編制,也能夠按內(nèi)容劃分成 多卷,例如: 工程開發(fā)打算可能包括:質(zhì)量保證打算,配置治理打算,用戶培訓(xùn)打算,安裝實(shí)施

14、打算; 系統(tǒng)設(shè)計(jì)講明書可分寫成: 系統(tǒng)設(shè)計(jì)講明書, 子系統(tǒng)設(shè)計(jì)講明書; 程序設(shè)計(jì)講明書可分寫成: 程序設(shè)計(jì)講明書, 接口設(shè)計(jì)講明書, 版本講明;操作手冊可分寫成:操作手冊,安裝實(shí)施過程; 測試打算可分寫成: 測試打算,測試設(shè)計(jì)講明,測試規(guī)程,測試用例; 測試分析報(bào)告可分寫成:綜合測試報(bào)告,驗(yàn)收測試報(bào)告; 工程開發(fā)總結(jié)報(bào)告亦可分寫成工程開發(fā)總結(jié)報(bào)告和資源環(huán)境統(tǒng)計(jì)。 節(jié)的擴(kuò)張與縮并 在有些文件中,能夠使用本指南所提供的章、條標(biāo)題,但在條內(nèi)又存 在一系列需要分不討論的因素本指南認(rèn)為,所有的條都能夠擴(kuò)展,能夠進(jìn) 一步細(xì)分,以適應(yīng)實(shí)際需要。反之,如果章條中的有些細(xì)節(jié);非必需,也 能夠按照實(shí)際情形縮并?,F(xiàn)

15、在章條的編號應(yīng)相應(yīng)地改變。程序設(shè)計(jì)的表現(xiàn)形式本指南關(guān)于程序的設(shè)計(jì)表現(xiàn)形式并未作出規(guī)定或限制,能夠使用流程 圖的形式、判定表的形式,能夠使用其他表現(xiàn)形式。2.2.3.6 文件的表現(xiàn)形式本指南關(guān)于文件的表現(xiàn)形式亦未作出規(guī)定或限制,能夠使用自然語言, 也能夠使用形式化語言。文件的其他種類當(dāng)本指南中規(guī)定的文件種類尚不能滿足某些應(yīng)用部門的專門需要時(shí), 他們能夠建立一些專門的文件種類要求,例如軟件質(zhì)量保證打算、軟件配 置治理打算等,這些要求能夠包含在本單位的文件編制實(shí)施規(guī)定中。3. 文件編制的治理工作文件編制工作必須有治理工作的配合,才能使所編制的文件真正發(fā)揮 它的作用。文件的編制工作實(shí)際上貫穿于一項(xiàng)軟件

16、的整個(gè)開發(fā)過程,因此, 對文件的治理必須貫穿于整個(gè)開發(fā)過程。在開發(fā)過程中必須進(jìn)行的治理工 作是以下四條。3.1 文件的形成開發(fā)集體中的每個(gè)成員,專門是工程負(fù)責(zé)人,應(yīng)該認(rèn)識到:文件是軟 件產(chǎn)品的必不可少的組成局部;在軟件開發(fā)過程的各個(gè)時(shí)期中,必須按照 規(guī)定及時(shí)地完成各種產(chǎn)品文件的編寫工作;必須把在一個(gè)開發(fā)步驟中作出 的決定和取得的結(jié)果及時(shí)地寫入文件;開發(fā)集體必須及時(shí)地對這些文件進(jìn) 行嚴(yán)格的評審;這些文件的形成是各個(gè)時(shí)期開發(fā)工作正式完成的標(biāo)志。這 些文件上必須有編寫者、評審者和批準(zhǔn)者的簽字,必須有編寫、評審?fù)瓿?的日期和批準(zhǔn)的日期。3.2 文件的分類與標(biāo)識在軟件開發(fā)的過程中,產(chǎn)生的文件是專門多的,

17、為了便于儲存、查找、 使用和修改,應(yīng)該對文件按層次地加以分類組織。一個(gè)軟件開發(fā)單位應(yīng)該建立一個(gè)對本單位文件的標(biāo)識方法,使文件的每一頁都具有明確的標(biāo)識。 例如能夠按如下四個(gè)層次對文件加以分類和標(biāo)識。a. 文件所屬的工程的標(biāo)識;b. 文件種類的標(biāo)識;c. 同一種文件的不同版本號;d. 頁號。此外,對每種文件還應(yīng)按照工程的性質(zhì),劃定它們各自的保密級不,確定 他們各自的發(fā)行范疇。3.3 文件的操縱在一項(xiàng)軟件的開發(fā)過程中,隨著程序的逐步形成和逐步修改,各種文 件亦在持續(xù)地產(chǎn)生、持續(xù)地修改或補(bǔ)充。因此,必須加以周密的操縱,以 保持文件與程序產(chǎn)品的一致性,保持各種文件之間的一致性和文件的平安 性。這種操縱表

18、現(xiàn)為:a. 就從事一項(xiàng)軟件開發(fā)工作的開發(fā)集體而言,應(yīng)當(dāng)設(shè)置一位專職的文 件治理人員接口治理工程師或文件治理員 ;在開發(fā)集體中,應(yīng)該集中保 管本工程現(xiàn)有全部文件的主文本兩套,由該文件治理人員負(fù)責(zé)保管;b. 每一份提交給文件治理人員的文件都必須具有編寫人、審核人和批 準(zhǔn)人的簽字;c. 這兩套主文本的內(nèi)容必須完全一致;其中有一套是可供出借的,另 一套是絕對不能出借的,以免發(fā)生萬一;可出借的主文本在出借時(shí)必須辦 理出借手續(xù),歸還時(shí)辦理注銷出借手續(xù);d. 開發(fā)集體中的工作人員能夠按照工作的需要,在本工程的開發(fā)過程 中持有一些文件,即所謂個(gè)人文件,包括為使他完成他承當(dāng)?shù)娜蝿?wù)所需要 的文件,以及他在完成任務(wù)

19、過程中所編制的文件;但這種個(gè)人文件必須是 主文本的復(fù)制品,必須同主文本完全一致,假設(shè)要修改,必須第一修改主文 本;e. 不同開發(fā)人員所擁有的個(gè)人文件通常是主文本的各種子集;所謂子 集是指把主文本的各個(gè)局部按照承當(dāng)不同任務(wù)的人員或部門的工作需要加以復(fù)制、組裝而成的假設(shè)干個(gè)文件的集合;文件治理人員。應(yīng)該列出一份不 同子集的分發(fā)對象的清單,按照清單及時(shí)把文件分發(fā)給有關(guān)人員或部門;f .一份文件如果差不多被另一份新的文件所代替,那么原文件應(yīng)該被注 銷;文件治理人中要隨時(shí)整理主文本,及時(shí)反映出文件的變化和增加情形, 及時(shí)分發(fā)文件;g.當(dāng)一個(gè)工程的開發(fā)工作臨近終止時(shí),文件治理人員應(yīng)逐個(gè)收回開發(fā)集體內(nèi)每個(gè)成

20、員的個(gè)人文件,并檢查這些個(gè)人文件的內(nèi)容;體會說明,這 些個(gè)人文件往往可能比主文本更詳細(xì),或同主文本的內(nèi)容有所不同,必須 認(rèn)真監(jiān)督有關(guān)人員進(jìn)行修改,使主文本能真正反映實(shí)際的開發(fā)結(jié)果。3.4 文件的修改治理在一個(gè)工程的開發(fā)過程中的任何時(shí)刻,開發(fā)集體內(nèi)的所有成員都可能對開發(fā)工作的已有成果文件,提出進(jìn)行修改的要求。提出修改要求的 理由可能是各種各樣的,進(jìn)行修改而引起的阻礙可能專門小,也可能會牽 涉到本工程的專門多方面。因此,修改活動的進(jìn)行必須慎重,必須對修改 活動的進(jìn)行加以治理,必須執(zhí)行修改活動的規(guī)程,使整個(gè)修改活動有操縱 地進(jìn)行。修改活動可分如下五個(gè)步驟進(jìn)行:a. 提議開發(fā)集體中的任何一個(gè)成員都能夠

21、向工程負(fù)責(zé)人提出修改建議,為此應(yīng)該填寫一份修改建議表,講明修改的內(nèi)容、所修改的文件和部 位、以及修改理由;b. 評議由工程負(fù)責(zé)人或工程負(fù)責(zé)人指定的人員對該修改建議進(jìn)行評議,包括審查該項(xiàng)修改的必要性、確定這一修改的阻礙范疇、研究進(jìn)行修 改的方法、步驟和實(shí)施打算;c. 審核一樣由工程負(fù)責(zé)人進(jìn)行審核,包括核實(shí)修改的自的和要求、核實(shí)修改活動將帶來的阻礙、審核修改活動打確實(shí)是否可行;d. 批準(zhǔn)在一樣情形下,批準(zhǔn)權(quán)屬于該開發(fā)單位的部門負(fù)責(zé)人;在批準(zhǔn) 時(shí),要緊是決斷修改工作中各項(xiàng)活動的先后順序及各自的完成日期,以保 證整個(gè)開發(fā)工作按原定打算日期完成;e. 實(shí)施由工程負(fù)責(zé)人按照已批準(zhǔn)的修改活動打算,安排各項(xiàng)修

22、改活動 的負(fù)責(zé)人員進(jìn)行修改,建立修改記錄、產(chǎn)生新的文件以取代原有文件、最 后把文件交文件治理人員歸檔,并分發(fā)給有關(guān)的持有者。4. 各種文件的內(nèi)容要求 本篇將對引言中提到的十四種文件提供內(nèi)容要求,作為文件編制的技 術(shù)標(biāo)準(zhǔn)。4.1 可行性研究報(bào)告 可行性研究報(bào)告的編寫目的是:講明該軟件開發(fā)工程的實(shí)現(xiàn)在技術(shù)、 經(jīng)濟(jì)和社會條件方面的可行性;評述為了合理地到達(dá)開發(fā)目標(biāo)而可能選擇 的各種方案;講明并論證所選定的方案。可行性研究報(bào)告的編寫內(nèi)容要求如下:1 引言1.1 編寫目的1.2 背景1.3 定義1.4 參考資料2 可行性研究的前提2.1 要求2.2目標(biāo)2.3 條件、假定和限制2.4 進(jìn)行可行性研究的方法

23、2.5 評判尺度3 對現(xiàn)有系統(tǒng)的分析3.1 數(shù)據(jù)流程和處理流程3.2 工作負(fù)荷3.3 費(fèi)用開支3.4人員3.5 設(shè)備3.6 局限性4 所建議的系統(tǒng)4.1 對所建議系統(tǒng)的講明4.2 數(shù)據(jù)流程和處理流程4.3 改良之處4.4 阻礙4.4.1 對設(shè)備的阻礙4.4.2 對軟件的阻礙4.4.3 對用戶單位機(jī)構(gòu)的阻礙4.4.4 對系統(tǒng)運(yùn)行的阻礙4.4.5 對開發(fā)的阻礙4.4.6 對地點(diǎn)和設(shè)施的阻礙4.4.7 對經(jīng)費(fèi)開支的阻礙4.5 局限性4.6 技術(shù)條件方面的可行性5 可選擇的其他系統(tǒng)方案5.1 可選擇的系統(tǒng)方案 15.2 可選擇的系統(tǒng)方案 26 投資及收益分析6.1 支出6.1.1 差不多建設(shè)投資6.1

24、.2 其他一次性支出6.1.3 非一次性支出6.2 收益6.2.1 一次性收益6.2.2 非一次性收益6.2.3 不可定量的收益6.3 收益投資比6.4 投資回收周期6.5 敏銳性分析7 社會條件方面的可行性7.1 法律方面的可行性7.2 使用方面的可行性8 結(jié)論4.2 工程開發(fā)打算編制工程開發(fā)打算的目的是用文件的形式,把關(guān)于在開發(fā)過程中各項(xiàng) 工作的負(fù)責(zé)人員、開發(fā)進(jìn)度、所需經(jīng)費(fèi)預(yù)算、所需軟、硬件條件等咨詢題 作出的安排記載下來,以便按照本打算開展和檢查本工程的開發(fā)工作。編 制內(nèi)容要求如下:1. 概述1.1 編寫目的1.2 工程背景1.3 定義1.4 參考資料2. 工程過程定義2.1 軟件開發(fā)生

25、命周期模型2.2 開發(fā)工具與平臺3. 打算3.1 資源打算3.2 關(guān)鍵運(yùn)算機(jī)資源估量4. 工程治理4.1 人員與角色4.2 人員打算4.3 風(fēng)險(xiǎn)治理打算4.4 培訓(xùn)打算4.5 本錢估量5. 進(jìn)度跟蹤5.1 工程會議5.2 工程里程碑5.3 進(jìn)度表5.4 人員任務(wù)分配4.3 軟件需求講明書 軟件需求講明書的編制是為了使用戶和軟件開發(fā)者雙方對該軟件的初 始規(guī)定有一個(gè)共同的明白得,使之成為整個(gè)開發(fā)工作的根底。編制軟件需 求講明書的內(nèi)容要求如下:1. 引言1.1 編寫目的1.2 工程背景1.3 定義1.4 參考資料2. 任務(wù)概述2.1 目標(biāo)2.2 運(yùn)行環(huán)境2.3 條件與限制3. 數(shù)據(jù)描述3.1 靜態(tài)數(shù)

26、據(jù)3.2 動態(tài)數(shù)據(jù)3.3 數(shù)據(jù)庫介紹3.4 數(shù)據(jù)詞典3.5 數(shù)據(jù)采集4. 功能需求4.1 功能劃分4.2 功能描述5. 性能需求5.1 數(shù)據(jù)精確度5.2 時(shí)刻特性5.3 適應(yīng)性6.運(yùn)行需求6.1 用戶界面6.2 硬件接口6.3 軟件接口6.4 故障處理7.其它需求4.4 數(shù)據(jù)要求講明書數(shù)據(jù)要求講明書的編制目的是為了向整個(gè)開發(fā)時(shí)期提供關(guān)于被處理數(shù)據(jù)的描述和數(shù)據(jù)采集要求的技術(shù)信息。編制數(shù)據(jù)要求講明書的內(nèi)容要求如下:1 引言1.1 編寫目的1.2 背景1.3 定義1.4 參考資料2 數(shù)據(jù)的邏輯描述2.1 靜態(tài)數(shù)據(jù)2.2 動態(tài)輸入數(shù)據(jù)2.3 動態(tài)輸出數(shù)據(jù)2.4 內(nèi)部生成數(shù)據(jù)2.5 數(shù)據(jù)約定3 數(shù)據(jù)的采

27、集3.1 要求和范疇3.2 輸入的承當(dāng)者3.3 處理3.4 阻礙4.5 概要設(shè)計(jì)講明書概要設(shè)計(jì)講明書又可稱系統(tǒng)設(shè)計(jì)講明書,那個(gè)地點(diǎn)所講的系統(tǒng)是指程 序系統(tǒng)。編制的目的是講明對程序系統(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ì)提供根底。 編制概要設(shè)計(jì)講明書的內(nèi)容要求如下:1 引言1.1 編寫目的1.2 背景1.3 定義1.4 參考資料2 總體設(shè)計(jì)2.1 需求規(guī)定2.2 運(yùn)行環(huán)境2.3 差不多設(shè)計(jì)概念和處理流程2.4 結(jié)構(gòu)2.5 功能需求與程序的關(guān)系2.6 人工處理過程2.7 尚未解決的咨

28、詢題3 接口設(shè)計(jì)3.1 用戶接口3.2 外部接口3.3 內(nèi)部接口4 運(yùn)行設(shè)計(jì)4.1 運(yùn)行模塊組合4.2 運(yùn)行操縱4.3 運(yùn)行時(shí)刻5 系統(tǒng)論據(jù)結(jié)構(gòu)設(shè)計(jì)5.1 邏輯結(jié)構(gòu)設(shè)計(jì)要點(diǎn)5.2 物理結(jié)構(gòu)設(shè)計(jì)要點(diǎn)5.3 數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系6 系統(tǒng)出錯(cuò)處理設(shè)計(jì)6.1 出錯(cuò)信息6.2補(bǔ)救措施7 平安保密設(shè)計(jì)8 系統(tǒng)保護(hù)設(shè)計(jì)4.6 詳細(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ì)講明書。對詳細(xì)設(shè)計(jì)講明書的內(nèi)容要求如下:1 引言1.1 編寫目的1.2

29、背景1.3 定義1.4 參考資料2 程序系統(tǒng)的組織結(jié)構(gòu)3 程序 1標(biāo)識符設(shè)計(jì)講明3.1 程序描述3.2 功能3.3 性能3.4 輸入項(xiàng)3.5 輸出項(xiàng)3.6 算法3.7 流程邏輯3.8 接口3.9 儲藏分配3.10 注釋設(shè)計(jì)3.11限制條件3.12測試打算.3.13 尚未解決的咨詢題4 程序 2標(biāo)識符設(shè)計(jì)講明4.7 數(shù)據(jù)庫設(shè)計(jì)講明書數(shù)據(jù)庫設(shè)計(jì)講明書的編制目的是關(guān)于設(shè)計(jì)中的數(shù)據(jù)庫的所有標(biāo)識、邏 輯結(jié)構(gòu)和物理結(jié)構(gòu)作出具體的設(shè)計(jì)規(guī)定。其內(nèi)容要求如下:1 引言1.1 編寫目的1.2 背景1.3 定義1.4 參考資料2 外部設(shè)計(jì)2.1 標(biāo)識符和狀態(tài)2.2 使用它的程序2.3 約定2.4 專門指導(dǎo)2.5 支

30、持軟件3 結(jié)構(gòu)設(shè)計(jì)3.1 概念結(jié)構(gòu)設(shè)計(jì)3.2 邏輯結(jié)構(gòu)設(shè)計(jì)3.3 物理結(jié)構(gòu)設(shè)計(jì)4 運(yùn)用設(shè)計(jì)4.1 數(shù)據(jù)字典設(shè)計(jì)4.2 平安保密設(shè)計(jì)4.8 用戶手冊 用戶手冊的編制是要使用非專門術(shù)語的語言,充分地描述該軟件系統(tǒng) 所具有的功能及差不多的使用方法。使用戶或潛在用戶通過本手冊能 夠了解該軟件的用途,同時(shí)能夠確定在什么情形下,如何使用它。具體的 內(nèi)容要求如下:1 引言1.1 編寫目的1.2 背景1.3 定義1.4 參考資料2 用途2.1 功能2.2 性能2.2.1 精度2.2.2 時(shí)刻特性2.2.3 靈活性2.3 平安保密3 運(yùn)行環(huán)境3.1 硬設(shè)備3.2 支持軟件3.3 數(shù)據(jù)結(jié)構(gòu)4 使用過程4.1 安裝

31、與初始化4.2 輸入輸入數(shù)據(jù)的現(xiàn)實(shí)背景4.2.2 輸入格式4.2.3 輸入舉例4.3 輸出輸出數(shù)據(jù)的現(xiàn)實(shí)背景4.3.2 輸出格式4.3.3 輸出舉例4.4 文卷查詢4.5 出錯(cuò)處理與復(fù)原4.6 終端操作4.9 操作手冊 操作手冊的編制是為了向操作人員提供該軟件每一個(gè)運(yùn)行的具體過程 和有關(guān)知識,包括操作方法的細(xì)節(jié)。具體的內(nèi)容要求如下:1 引言1.1 編寫目的1.2 背景1.3 定義1.4 參考資料2 軟件概述2.1 軟件的結(jié)構(gòu)2.2 程序表2.3 文卷表3 安裝與初始化4 運(yùn)行講明4.1 運(yùn)行表4.2 運(yùn)行步驟4.3 運(yùn)行 1標(biāo)識符講明4.3.1 運(yùn)行操縱4.3.2 操作信息4.3.3 輸入一輸

32、出文卷4.3.4 輸出文段4.3.5 輸出文段的復(fù)制4.3.6 啟動復(fù)原過程4.4 運(yùn)行 2標(biāo)識符講明5 專門現(xiàn)過程6 遠(yuǎn)程操作4.10 模塊開發(fā)卷宗模塊開發(fā)卷宗是在模塊開發(fā)過程中逐步編寫出來的,每完成一個(gè)模塊 或一組緊密有關(guān)的模塊的復(fù)審時(shí)編寫一份,應(yīng)該把所有的模塊開發(fā)卷宗聚 攏在一起。編寫的目的是記錄和匯總低層次開發(fā)的進(jìn)度和結(jié)果,以便于對 整個(gè)模塊開發(fā)工作的治理和復(fù)審,并為今后的保護(hù)提供專門有用的技術(shù)信 息。具體的內(nèi)容要求如下:1 標(biāo)題2 模塊開發(fā)情形表見下表模塊開發(fā)情形表3 功能講明4 設(shè)計(jì)講明5 源代碼清單6 測試講明7 復(fù)審的結(jié)論4.11測試打算及設(shè)計(jì)那個(gè)地點(diǎn)所講的測試,要緊是指整個(gè)程序系統(tǒng)的組裝測試和確認(rèn)測試 本文件的編制是為了提供一個(gè)對該軟件的測試打算,包括對每項(xiàng)測試活動 的內(nèi)容、進(jìn)度安排、設(shè)計(jì)考慮、測試數(shù)據(jù)的整理方法及評判準(zhǔn)那么。具體的 內(nèi)容要求如下:1 引言1.1 編寫目的1.2 背景1.3 定義1.4 參考資料2 打算2.1 軟件講明2.2 測試內(nèi)容2.3 測試 1標(biāo)識符2.3.1 進(jìn)度安排2.3.2 條件2.3.3 測試資料2.3.4 測試培訓(xùn)2.4 測試 2標(biāo)識符3 測試設(shè)計(jì)講明3.1測試I 標(biāo)識符3

溫馨提示

  • 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁內(nèi)容里面會有圖紙預(yù)覽,若沒有圖紙預(yù)覽就沒有圖紙。
  • 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
  • 5. 人人文庫網(wǎng)僅提供信息存儲空間,僅對用戶上傳內(nèi)容的表現(xiàn)方式做保護(hù)處理,對用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對任何下載內(nèi)容負(fù)責(zé)。
  • 6. 下載文件中如有侵權(quán)或不適當(dāng)內(nèi)容,請與我們聯(lián)系,我們立即糾正。
  • 7. 本站不保證下載資源的準(zhǔn)確性、安全性和完整性, 同時(shí)也不承擔(dān)用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。

最新文檔

評論

0/150

提交評論