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