1 目的
一項(xiàng)計算機(jī)軟件的籌劃、研制及實(shí)現(xiàn)，構(gòu)成一個軟件開發(fā)項(xiàng)目。一個軟件開發(fā)項(xiàng)目的進(jìn)行，一般需要在人力和自動化資源等方面作重大的投資。為了保證項(xiàng)目開發(fā)的成功，最經(jīng)濟(jì)地花費(fèi)這些投資，并且便于運(yùn)行和維護(hù)，在開發(fā)工作的每一階段，都需要編制二定的文件。這些文件連同計算機(jī)程序及數(shù)據(jù)一起，構(gòu)成為計算機(jī)軟件。文件是計算機(jī)軟件中不可缺少的組成部分，它的作用是：
a．作為開發(fā)人員在一定階段內(nèi)的工作成果和結(jié)束標(biāo)志；
b．向管理人員提供軟件開發(fā)過程中的進(jìn)展和情況，把軟件開發(fā)過程中的一些"不可見的"事物轉(zhuǎn)換成"可見?quot;文字資料。以便管理人員在各個階段檢查開發(fā)計劃的實(shí)施進(jìn)展，使之能夠判斷原定目標(biāo)是否已達(dá)到，還將繼續(xù)耗用資源的種類和數(shù)量；
C．記錄開發(fā)過程中的技術(shù)信息，便于協(xié)調(diào)以后的軟件開發(fā)、使用和修改；
d．提供對軟件的有關(guān)運(yùn)行、維護(hù)和培訓(xùn)的信息，便于管理人員、開發(fā)人員、操作人員和用戶之間相互了解彼此的工作；
e．向潛在用戶報導(dǎo)軟件的功能和性能，使他們能判定該軟件能否服務(wù)于自己的需要。
換言之，本指南認(rèn)為：文件的編制必須適應(yīng)計算機(jī)軟件整個生存周期的需要。
計算機(jī)軟件所包含的文件有兩類：一類是開發(fā)過程中填寫的各種圖表，可稱之為工作表格；另一類則是應(yīng)編制的技術(shù)資料或技術(shù)管理資料，可稱之為文件。本指南規(guī)定軟件文件的編制形式，并提供對這些規(guī)定的解釋。本指南的目的是使得所編制的軟件文件確實(shí)能夠起到軟件文件應(yīng)該發(fā)揮的作用。
2 范圍
本指南是一份指導(dǎo)性文件。本指甫建議，在一項(xiàng)計算機(jī)軟件的開發(fā)過程中，一般地說，應(yīng)該產(chǎn)生十四種文件。這十四種文件是：
可行性研究報告；
項(xiàng)目開發(fā)計劃；
軟件需求說明書；
數(shù)據(jù)要求說明書；
概要設(shè)計說明書；
詳細(xì)設(shè)計說明書；
數(shù)據(jù)庫設(shè)計說明書；
用戶手冊；
操作手冊；
模塊開發(fā)卷宗；
測試計劃；
測試分析報告；
開發(fā)進(jìn)度月報；
項(xiàng)目開發(fā)總結(jié)報告。
本指南將給出開發(fā)過程中建議產(chǎn)生的這十四種文件的編制指導(dǎo)，同時，本指南也是這十四種文件的編寫質(zhì)量的檢驗(yàn)準(zhǔn)則。但是，本指南并未涉及軟件開發(fā)過程中如何填寫工作表格的問題。
一般地說，一個軟件總是一個計算機(jī)系統(tǒng)（包括硬件、固件和軟件）的組成部分。鑒于計算機(jī)系統(tǒng)的多樣性，本指南一般不涉及整個系統(tǒng)開發(fā)中的文件編制問題，本指南僅僅是軟件開發(fā)過程中的文件編制指南。
3 文件的使用者
對于使用文件的人員而言，他們所關(guān)心的文件的種類，隨他們所承擔(dān)的工作而異。
管理人員：可行性研究報告，項(xiàng)目開發(fā)計劃，模塊開發(fā)卷宗，開發(fā)進(jìn)度月報，項(xiàng)目開發(fā)總結(jié)報告；
開發(fā)人員：可行性研究報告，項(xiàng)目開發(fā)計劃，軟件需求說明書，數(shù)據(jù)要求說明書，概要設(shè)計說明書，詳細(xì)設(shè)計說明書，數(shù)據(jù)庫設(shè)計說明書，測試計劃，測試分析報告；
維護(hù)人員：設(shè)計說明書，測試分析報告，模塊開發(fā)卷宗；
用戶：用戶手冊，操作手冊。
盡管本指南提出了在軟件開發(fā)中文件編制的要求，但并不意味著這些文件都必須交給用戶。一項(xiàng)軟件的用戶應(yīng)該得到的文件的種類由供應(yīng)者與用戶之間簽訂的合同規(guī)定。
4 軟件生存周期與各種文件的編制
一項(xiàng)計算機(jī)軟件，從出現(xiàn)一個構(gòu)思之日起，經(jīng)過這項(xiàng)軟件開發(fā)成功投入使用，直到最后決定停止使用，并被另一一項(xiàng)軟件代替之時止，被認(rèn)為是該軟件的一個生存周期。一般地說這個軟件生存周期可以分成以下六個階段：
可行性與計劃研究階段
需求分析階段
設(shè)計階段
實(shí)現(xiàn)階段
測試階段
運(yùn)行與維護(hù)階段
在可行性研究與計劃階段內(nèi)，要確定該軟件的開發(fā)目標(biāo)和總的要求，要進(jìn)行可行性分析、投資一收益分析、制訂開發(fā)計劃，并完成應(yīng)編制的文件。
在需求分析階段內(nèi)，由系統(tǒng)分析人員對被設(shè)計的系統(tǒng)進(jìn)行系統(tǒng)分析，確定對該軟件的各項(xiàng)功能、性能需求和設(shè)計約束，確定對文件編制的要求，作為本階段工作的結(jié)果，一般地說，軟件需求說明書、數(shù)據(jù)要求說明書和初步的用戶手冊應(yīng)該編寫出來。
在設(shè)計階段內(nèi)，系統(tǒng)設(shè)計人員和程序設(shè)計人員應(yīng)該在反復(fù)理解軟件需求的基礎(chǔ)上，提出多個設(shè)計，分析每個設(shè)計能履行的功能并進(jìn)行相互比較，最后確定一個設(shè)計，包括該軟件的結(jié)構(gòu)、模塊的劃分、功能的分配以及處理流程。在被設(shè)計系統(tǒng)比較復(fù)雜的情況下，設(shè)計階段應(yīng)分解成概要設(shè)計階段和詳細(xì)設(shè)計階段兩個步驟。在一般情況下，應(yīng)完成的文件包括：概要設(shè)計說明書、詳細(xì)設(shè)計說明書和測試計劃初稿。
在實(shí)現(xiàn)階段內(nèi)，要完成源程序的編碼、編譯（或匯編）和排錯調(diào)試得到無語法錯的程序清單，要開始編寫模塊開發(fā)卷宗，并且要完成用戶手冊、操作手冊等面向用戶的文件的編寫工作，還要完成測試計劃的編制。
在測試階段，該程序?qū)⒈蝗娴販y試，已編制的文件將被檢查審閱。一般要完成模塊開發(fā)卷宗和測試分析報告，作為開發(fā)工作的結(jié)束，所生產(chǎn)的程序、文件以及開發(fā)工作本身將逐項(xiàng)被評價，最后寫出項(xiàng)目開發(fā)總結(jié)報告。
在整個開發(fā)過程中（即前五個階段中），開發(fā)集體要按月編寫開發(fā)進(jìn)度月報。
在運(yùn)行和維護(hù)階段，軟件將在運(yùn)行使用中不斷地被維護(hù)，根據(jù)新提出的需求進(jìn)行必要而且可能的擴(kuò)充和刪改。
對于一項(xiàng)軟件而言，其生存周期各階段與各種文件編寫工作的關(guān)系可見表互，其中有些文件的編寫工作可能要在若干個階段中延續(xù)進(jìn)行。
表1軟件生存周期各階段中的文件編制
5 文件編制中的考慮因素
文件編制是一個不斷努力的工作過程。是一個從形成最初輪廓，經(jīng)反復(fù)檢查和修改，直到程序和文件正式交付使用的完整過程。其中每一步都要求工作人員做出很大努力。要保證文件編制的質(zhì)量，要體現(xiàn)每個開發(fā)項(xiàng)目的特點(diǎn)，也要注意不要花太多的人力。為此，編制中要考慮如下各項(xiàng)因素。
5．1 文件的讀者
每一種文件都具有特定的讀者。這些讀者包括個人或小組、軟件開發(fā)單位的成員或社會上的公眾、從事軟件工作的技術(shù)人員、管理人員或領(lǐng)導(dǎo)干部。他們期待著使用這些文件的內(nèi)容來進(jìn)行工作，例如設(shè)計、編寫程序、測試、使用、維護(hù)或進(jìn)行計劃管理。因此，這些文件的作者必須了解自己的讀者，這些文件的編寫必須注意適應(yīng)自己的特定讀者的水平、特點(diǎn)和要求。
5．2 重復(fù)性
本指南第二篇中將列出的這十四種文件的內(nèi)容要求中，顯然存在某些重復(fù)。較明顯的重復(fù)有兩類。引言是每一種文件都要包含的內(nèi)容，以向讀者提供總的梗概。第二類明顯的重復(fù)是各種文件中的說明部分，如對功能性能的說明、對輸入和輸出的描述、系統(tǒng)中包含的設(shè)備等。這是為了方便每種文件各自的讀者，每種產(chǎn)品文件應(yīng)該自成體系，盡量避免讀一種文件時又不得不去參考另一種文件。當(dāng)然，在每一種文件里，有關(guān)引言、說明等同其他文件相重復(fù)的部分，在行文上、在所用的術(shù)語上、在詳細(xì)的程度上，還是應(yīng)該有一些差別，以適應(yīng)各種文件的不同讀者的需要。
5．3 靈活性
鑒于軟件開發(fā)是具有創(chuàng)造性的腦力勞動，也鑒于不同軟件在規(guī)模上和復(fù)雜程度上差別極大，本指南認(rèn)為在文件編制工作中應(yīng)允許一定的靈活性。這種靈活性表現(xiàn)在如下各款。
5．3．1 應(yīng)編制的文件種類
盡管本指南認(rèn)為在一般情況下，一項(xiàng)軟件的開發(fā)過程中，應(yīng)產(chǎn)生的文件有十四種，然而針對一項(xiàng)具體的軟件開發(fā)項(xiàng)目，有時不必編制這么多的文件，可以把幾種文件合并成一種。一般地說，當(dāng)項(xiàng)目的規(guī)模、復(fù)雜性和成敗風(fēng)險增大時，文件編制的范圍、管理手續(xù)和詳細(xì)程度將隨之增加。反之，則可適當(dāng)減少。為了恰當(dāng)?shù)卣莆者@種靈活性，本指南要求貫徹分工負(fù)責(zé)的原則，這意味著：
a: 一個軟件開發(fā)單位的領(lǐng)導(dǎo)機(jī)構(gòu)應(yīng)該根據(jù)本單位經(jīng)營承包的應(yīng)用軟件的專業(yè)領(lǐng)域和本單位的管理能力，制定一個對文件編制要求的實(shí)施規(guī)定，主要是：在不同的條件下，應(yīng)該形成哪些文件？這些文件的詳細(xì)程度？該開發(fā)單位的每一個項(xiàng)目負(fù)責(zé)人，必須認(rèn)真執(zhí)行這個實(shí)施規(guī)定。這種規(guī)定的兩個例子可嘆本指南的附錄o（參考件）；
b．對于一個具體的應(yīng)用軟件項(xiàng)目，項(xiàng)目負(fù)責(zé)人應(yīng)根據(jù)上述實(shí)施規(guī)定，確定一個文件編制計劃，主中包括:
?。?/span>1）應(yīng)該編制哪幾種文件，詳細(xì)程度如何？
?。?/span>2）各個文件的編制負(fù)責(zé)人和進(jìn)度要求；
?。?/span>3）審查、批準(zhǔn)的負(fù)責(zé)人和時間進(jìn)度安排；
?。?/span>4）在開發(fā)時期內(nèi)，各文件的維護(hù)、修改和管理的負(fù)責(zé)人，以及批準(zhǔn)手續(xù)。
每項(xiàng)工作必須落實(shí)到人。
這個文件編制計劃是整個開發(fā)計劃的重要組成部分；
C．有關(guān)的設(shè)計人員則必須嚴(yán)格執(zhí)行這個文件編制計劃。
5．3．2 文件的詳細(xì)程度
從同一份提綱起草的文件的篇幅大小往往不同，可以少到幾頁，也可以長達(dá)幾百頁。對于這種差別本指南是允許的。此詳細(xì)程度取決于任務(wù)的規(guī)模、復(fù)雜性和項(xiàng)目負(fù)責(zé)人對該軟件的開發(fā)過程及運(yùn)行環(huán)與所需要的詳細(xì)程度的判斷。
5．3．3 文件的擴(kuò)展
當(dāng)被開發(fā)系統(tǒng)的規(guī)模非常大（例如源碼超過一百萬行）時，一種文件可以分成幾卷編寫，可以按其。每一個系統(tǒng)分別編制，也可以按內(nèi)容劃分成多卷，例如：
項(xiàng)目開發(fā)計劃可能包括：質(zhì)量保證計劃，配置管理計劃，用戶培訓(xùn)計劃，安裝實(shí)施計劃；
系統(tǒng)設(shè)計說明書可分寫成：系統(tǒng)設(shè)計說明書，子系統(tǒng)設(shè)計說明書；
程序設(shè)計說明書可分寫成：程序設(shè)計說明書，接口設(shè)計說明書，版本說明；
操作手冊可分寫成：操作手冊，安裝實(shí)施過程；
測試計劃可分寫成：測試計劃，測試設(shè)計說明，測試規(guī)程，測試用例；
測試分析報告可分寫成：綜合測試報告，驗(yàn)收測試報告；
項(xiàng)目開發(fā)總結(jié)報告亦可分寫成項(xiàng)目開發(fā)總結(jié)報告和資源環(huán)境統(tǒng)計。
5．3．4 節(jié)的擴(kuò)張與縮并
在有些文件中，可以使用本指南所提供的章、條標(biāo)題，但在條內(nèi)又存在一系列需要分別討論的因素本指南認(rèn)為，所有的條都可以擴(kuò)展，可以進(jìn)一步細(xì)分，以適應(yīng)實(shí)際需要。反之，如果章條中的有些細(xì)節(jié)；非必需，也可以根據(jù)實(shí)際情況縮并。此時章條的編號應(yīng)相應(yīng)地改變。
5．3．5 程序設(shè)計的表現(xiàn)形式
本指南對于程序的設(shè)計表現(xiàn)形式并未作出規(guī)定或限制，可以使用流程圖的形式、判定表的形式，1 可以使用其他表現(xiàn)形式，如程序設(shè)計語言（PDL）、問題分析圖（PAD）等。
5．3．6 文件的表現(xiàn)形式
本指南對于文件的表現(xiàn)形式亦未作出規(guī)定或限制，可以使用自然語言，也可以使用形式化語言。 5．3．7 文件的其他種類
當(dāng)本指南中規(guī)定的文件種類尚不能滿足某些應(yīng)用部門的特殊需要時，他們可以建立一些特殊的文件種類要求，例如軟件質(zhì)量保證計劃、軟件配置管理計劃等，這些要求可以包含在本單位的文件編制實(shí)施規(guī)定中。
6 文件編制的管理工作
文件編制工作必須有管理工作的配合，才能使所編制的文件真正發(fā)揮它的作用。文件的編制工作實(shí)際上貫穿于一項(xiàng)軟件的整個開發(fā)過程，因此，對文件的管理必須貫穿于整個開發(fā)過程。在開發(fā)過程中必須進(jìn)行的管理工作是以下四條。
6．1文件的形成
開發(fā)集體中的每個成員，尤其是項(xiàng)目負(fù)責(zé)人，應(yīng)該認(rèn)識到：文件是軟件產(chǎn)品的必不可少的組成部分；在軟件開發(fā)過程的各個階段中，必須按照規(guī)定及時地完成各種產(chǎn)品文件的編寫工作；必須把在一個開發(fā)步驟中作出的決定和取得的結(jié)果及時地寫入文件；開發(fā)集體必須及時地對這些文件進(jìn)行嚴(yán)格的評審；這些文件的形成是各個階段開發(fā)工作正式完成的標(biāo)志。這些文件上必須有編寫者、評審者和批準(zhǔn)者的簽字，必須有編寫、評審?fù)瓿傻娜掌诤团鷾?zhǔn)的日期。
6．2文件的分類與標(biāo)識
在軟件開發(fā)的過程中，產(chǎn)生的文件是很多的，為了便于保存、查找、使用和修改，應(yīng)該對文件按層次地加以分類組織。一個軟件開發(fā)單位應(yīng)該建立一個對本單位文件的標(biāo)識方法，使文件的每一頁都具有明確的標(biāo)識。例如可以按如下四個層次對文件加以分類和標(biāo)識。
a．文件所屬的項(xiàng)目的標(biāo)識；
b．文件種類的標(biāo)識；
C．同一種文件的不同版本號；
d．頁號。
此外，對每種文件還應(yīng)根據(jù)項(xiàng)目的性質(zhì)，劃定它們各自的保密級別，確定他們各自的發(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)容必須完全一致；其中有一套是可供出借的，另一套是絕對不能出借的，以免發(fā)生萬一；可出借的主文本在出借時必須辦理出借手續(xù)，歸還時辦理注銷出借手續(xù)；
d．開發(fā)集體中的工作人員可以根據(jù)工作的需要，在本項(xiàng)目的開發(fā)過程中持有一些文件，即所謂個人文件，包括為使他完成他承擔(dān)的任務(wù)所需要的文件，以及他在完成任務(wù)過程中所編制的文件；但這種個人文件必須是主文本的復(fù)制品，必須同主文本完全一致，若要修改，必須首先修改主文本；
e．不同開發(fā)人員所擁有的個人文件通常是主文本的各種子集；所謂子集是指把主文本的各個部分根據(jù)承擔(dān)不同任務(wù)的人員或部門的工作需要加以復(fù)制、組裝而成的若干個文件的集合；文件管理人員。應(yīng)該列出一份不同子集的分發(fā)對象的清單，按照清單及時把文件分發(fā)給有關(guān)人員或部門；
f．一份文件如果已經(jīng)被另一份新的文件所代替，則原文件應(yīng)該被注銷；文件管理人中要隨時整理主文本，及時反映出文件的變化和增加情況，及時分發(fā)文件；
g．當(dāng)一個項(xiàng)目的開發(fā)工作臨近結(jié)束時，文件管理人員應(yīng)逐個收回開發(fā)集體內(nèi)每個成員的個人文件，并檢查這些個人文件的內(nèi)容；經(jīng)驗(yàn)表明，這些個人文件往往可能比主文本更詳細(xì)，或同主文本的內(nèi)容有所不同，必須認(rèn)真監(jiān)督有關(guān)人員進(jìn)行修改，使主文本能真正反映實(shí)際的開發(fā)結(jié)果。
6．4文件的修改管理
在一個項(xiàng)目的開發(fā)過程中的任何時刻，開發(fā)集體內(nèi)的所有成員都可能對開發(fā)工作的已有成果-- 文件，提出進(jìn)行修改的要求。提出修改要求的理由可能是各種各樣的，進(jìn)行修改而引起的影響可能很小，也可能會牽涉到本項(xiàng)目的很多方面。因此，修改活動的進(jìn)行必須謹(jǐn)慎，必須對修改活動的進(jìn)行加以管理，必須執(zhí)行修改活動的規(guī)程，使整個修改活動有控制地進(jìn)行。
修改活動可分如下五個步驟進(jìn)行：
a．提議開發(fā)集體中的任何一個成員都可以向項(xiàng)目負(fù)責(zé)人提出修改建議，為此應(yīng)該填寫一份修改建議表，說明修改的內(nèi)容、所修改的文件和部位、以及修改理由；
b．評議由項(xiàng)目負(fù)責(zé)人或項(xiàng)目負(fù)責(zé)人指定的人員對該修改建議進(jìn)行評議，包括審查該項(xiàng)修改的必要性、確定這一修改的影響范圍、研究進(jìn)行修改的方法、步驟和實(shí)施計劃；
c．審核一般由項(xiàng)目負(fù)責(zé)人進(jìn)行審核，包括核實(shí)修改的自的和要求、核實(shí)修改活動將帶來的影響、審核修改活動計劃是否可行；
d．批準(zhǔn)在一般情況下，批準(zhǔn)權(quán)屬于該開發(fā)單位的部門負(fù)責(zé)人；在批準(zhǔn)時，主要是決斷修改工作中各項(xiàng)活動的先后順序及各自的完成日期，以保證整個開發(fā)工作按原定計劃日期完成；
e．實(shí)施由項(xiàng)目負(fù)責(zé)人按照已批準(zhǔn)的修改活動計劃，安排各項(xiàng)修改活動的負(fù)責(zé)人員進(jìn)行修改，建立修改記錄、產(chǎn)生新的文件以取代原有文件、最后把文件交文件管理人員歸檔，并分發(fā)給有關(guān)的持有者。
掃碼關(guān)注公眾號
溫馨提示：因考試政策、內(nèi)容不斷變化與調(diào)整，信管網(wǎng)網(wǎng)站提供的以上信息僅供參考，如有異議，請以權(quán)威部門公布的內(nèi)容為準(zhǔn)！
信管網(wǎng)致力于為廣大信管從業(yè)人員、愛好者、大學(xué)生提供專業(yè)、高質(zhì)量的課程和服務(wù)，解決其考試證書、技能提升和就業(yè)的需求。
信管網(wǎng)軟考課程由信管網(wǎng)依托10年專業(yè)軟考教研傾力打造，官方教材參編作者和資深講師坐鎮(zhèn)，通過深研歷年考試出題規(guī)律與考試大綱，深挖核心知識與高頻考點(diǎn)，為學(xué)員考試保駕護(hù)航。面授、直播＆錄播，多種班型靈活學(xué)習(xí)，滿足不同學(xué)員考證需求，降低課程學(xué)習(xí)難度，使學(xué)習(xí)效果事半功倍。
相關(guān)內(nèi)容
信管網(wǎng)訂閱號
分享到微信
考試新手指南
學(xué)習(xí)計劃攻略
精華備考資料
案例論文干貨
章節(jié)模擬試題
免費(fèi)試聽課程
考試信息推送