軟件方面的文檔標(biāo)準(zhǔn)

在文檔標(biāo)準(zhǔn)方面，主要有《軟件文檔管理指南》（GB/T16680-1996）、《計(jì)算機(jī)軟件產(chǎn)品開發(fā)文件編制指南》（GB/T8567-2006）和《計(jì)算機(jī)軟件需求說明編制指南》（GB/T9385-2008）等三個標(biāo)準(zhǔn)。1.GB/T16680-1996GB/T16680-1996為那些對軟件或基于軟件的產(chǎn)品的開發(fā)負(fù)有職責(zé)的管理者提供軟件文檔的管理指南，目的在于協(xié)助管理者在他們的機(jī)構(gòu)中產(chǎn)生有效的文檔。該標(biāo)準(zhǔn)涉及策略、標(biāo)準(zhǔn)、規(guī)程、資源和計(jì)劃，管理者必須關(guān)注這些內(nèi)容，以便有效地管理軟件文檔。根據(jù)GB/T16680-1996的規(guī)定，文檔是指一種數(shù)據(jù)媒體和其上所記錄的數(shù)據(jù)，它具有一直性并可以由人或機(jī)器閱讀，通常僅用于描述人工可讀的內(nèi)容，例如，技術(shù)文件、設(shè)計(jì)文件、版本說明文件。軟件文檔的作用主要體現(xiàn)在管理依據(jù)、任務(wù)之間聯(lián)系的憑證、質(zhì)量保證、培訓(xùn)與參考、軟件維護(hù)支持、歷史檔案等方面。軟件文檔可歸入三種類別，分別是開發(fā)文檔（描述開發(fā)過程本身）、產(chǎn)品文檔（描述開發(fā)過程的產(chǎn)物）和管理文檔（記錄項(xiàng)目管理的信息）。（1）文檔計(jì)劃文檔計(jì)劃是指一個描述文檔編制工作方法的管理用文檔。該計(jì)劃主要描述要編制什么類型的文檔，這些文檔的內(nèi)容是什么，何時編寫，由誰編寫，如何編寫，以及什么是影響期望結(jié)果的可用資源和外界因素。文檔計(jì)劃一般包括以下方面的內(nèi)容：√列出應(yīng)編制文檔的目錄?！烫崾揪幹莆臋n應(yīng)參考的標(biāo)準(zhǔn)?！讨付ㄎ臋n管理員?！烫峁┚幹莆臋n所需要的條件，落實(shí)文檔編寫人員、所需經(jīng)費(fèi)以及編制工具等?！堂鞔_保證文檔質(zhì)量的方法，為了確保文檔內(nèi)容的正確性、合理性，應(yīng)采取一定的措施，如評審、鑒定等?！汤L制進(jìn)度表，以圖表形式列出在軟件生存期各階段應(yīng)產(chǎn)生的文檔、編制人員、編制日期、完成日期、評審日期等。此外，文檔計(jì)劃規(guī)定每個文檔要達(dá)到的質(zhì)量等級，以及為達(dá)到期望結(jié)果必須考慮哪些外部因素。文檔計(jì)劃還確定該計(jì)劃和文檔的分發(fā)，并且明確敘述參與文檔工作的所有人員的職責(zé)。（2）開發(fā)文檔開發(fā)文檔是描述軟件開發(fā)過程，包括軟件需求、軟件設(shè)計(jì)、軟件測試、保證軟件質(zhì)量的一類文檔，開發(fā)文檔也包括軟件的詳細(xì)技術(shù)描述（程序邏輯、程序間相互關(guān)系、數(shù)據(jù)格式和存儲等）。開發(fā)文檔起到如下作用：√它們是軟件開發(fā)過程中包含的所有階段之間的通信工具，它們記錄生成軟件需求、設(shè)計(jì)、編碼和測試的詳細(xì)規(guī)定和說明。√它們描述開發(fā)小組的職責(zé)。通過規(guī)定軟件、主題事項(xiàng)、文檔編制、質(zhì)量保證人員以及包含在開發(fā)過程中任何其他事項(xiàng)的角色來定義做什么、如何做和何時做?！趟鼈冇米鳈z驗(yàn)點(diǎn)而允許管理者評定開發(fā)進(jìn)度。如果開發(fā)文檔丟失、不完整或過時，管理者將失去跟蹤和控制軟件項(xiàng)目的一個重要工具。√它們形成了維護(hù)人員所要求的基本軟件文檔，而這些支持文檔可作為產(chǎn)品文檔的一部分；√它們記錄軟件開發(fā)的歷史?；镜拈_發(fā)文檔有可行性研究和項(xiàng)目任務(wù)書；需求規(guī)格說明；功能規(guī)格說明；設(shè)計(jì)規(guī)格說明，包括程序和數(shù)據(jù)規(guī)格說明；開發(fā)計(jì)劃；軟件集成和測試計(jì)劃；質(zhì)量保證計(jì)劃、標(biāo)準(zhǔn)、進(jìn)度；安全和測試信息。（3）產(chǎn)品文檔產(chǎn)品文檔規(guī)定關(guān)于軟件產(chǎn)品的使用、維護(hù)、增強(qiáng)、轉(zhuǎn)換和傳輸?shù)男畔ⅰ．a(chǎn)品文檔起到如下三種作用：√為使用和運(yùn)行軟件產(chǎn)品的任何人規(guī)定培訓(xùn)和參考信息?！淌沟媚切┪磪⒓颖拒浖_發(fā)的程序員維護(hù)它。√促進(jìn)軟件產(chǎn)品的市場流通或提高可接受性。產(chǎn)品文檔用于下列類型的讀者：√用戶。他們利用軟件輸入數(shù)據(jù)、檢索信息和解決問題?！踢\(yùn)行者。他們在計(jì)算機(jī)系統(tǒng)上運(yùn)行軟件?！叹S護(hù)人員。他們維護(hù)、增強(qiáng)或變更軟件。產(chǎn)品文檔包括如下內(nèi)容：√用于管理者的指南和資料，他們監(jiān)督軟件的使用?！绦麄髻Y料。通告軟件產(chǎn)品的可用性并詳細(xì)說明它的功能、運(yùn)行環(huán)境等。√一般信息。對任何有興趣的人描述軟件產(chǎn)品?；镜漠a(chǎn)品文檔有培訓(xùn)手冊、參考手冊和用戶指南、軟件支持手冊、產(chǎn)品手冊和信息廣告。（4）管理文檔管理文檔建立在項(xiàng)目信息的基礎(chǔ)上，諸如：√開發(fā)過程的每個階段的進(jìn)度和進(jìn)度變更的記錄?！誊浖兏闆r的記錄?！滔鄬τ陂_發(fā)的判定記錄。√職責(zé)定義。這種文檔從管理的角度規(guī)定涉及軟件生存的信息。相關(guān)文檔的詳細(xì)規(guī)定和編寫格式見GB8567-2006。（5）文檔等級文檔等級是指所所需文檔的一個說明，它指出文檔的范圍、內(nèi)容、格式及質(zhì)量，可以根據(jù)項(xiàng)目、費(fèi)用、預(yù)期用途、作用范圍或其他因素選擇文檔等級。每個文檔的質(zhì)量必須在文檔計(jì)劃期間就有明確的規(guī)定，文檔的質(zhì)量可以按文檔的形式和列出的要求劃分為四級?！套畹拖薅任臋n（1級文檔）：適合開發(fā)工作量低于1人月的開發(fā)者自用程序。該文檔應(yīng)包含程序清單、開發(fā)記錄、測試數(shù)據(jù)和程序簡介?！虄?nèi)部文檔（2級文檔）：可用于在精心研究后被認(rèn)為似乎沒有與其他用戶共享資源的專用程序。除1級文檔提供的信息外，2級文檔還包括程序清單內(nèi)足夠的注釋以幫助用戶安裝和使用程序?！坦ぷ魑臋n（3級文檔）：適合于由同一單位內(nèi)若干人聯(lián)合開發(fā)的程序，或可被其他單位使用的程序?！陶轿臋n（4級文檔）：適合那些要正式發(fā)行供普遍使用的軟件產(chǎn)品。關(guān)鍵性程序或具有重復(fù)管理應(yīng)用性質(zhì)（如工資計(jì)算）的程序需要4級文檔。4級文檔應(yīng)遵守GB8567-2006的有關(guān)規(guī)定。（6）文檔評審為了提高軟件產(chǎn)品的質(zhì)量，一個有效的方法就是在軟件開發(fā)的每個階段，對該階段所形成的文檔進(jìn)行嚴(yán)格評審，這樣可盡早發(fā)現(xiàn)問題，并及時采取措施予以解決，從而確保文檔內(nèi)容的正確性，避免或減少大的返工，同時為進(jìn)入下一階段的工作做好組織上和技術(shù)上的準(zhǔn)備。無論項(xiàng)目大小或項(xiàng)目管理的正規(guī)化程度，需求評審和設(shè)計(jì)評審是必不可少的。需求評審進(jìn)一步確認(rèn)開發(fā)者和設(shè)計(jì)者已了解用戶要求什么，及用戶從開發(fā)者一方了解某些限制和約束。需求評審（可能需要一次以上）產(chǎn)生一個被認(rèn)可的需求規(guī)格說明?；趯ο到y(tǒng)要做些什么的共同理解，才能著手詳細(xì)設(shè)計(jì)。用戶代表必須積極參與開發(fā)和需求評審，參與對需求文檔的認(rèn)可。設(shè)計(jì)評審?fù)ǔ０才艃蓚€主要的設(shè)計(jì)評審：概要設(shè)計(jì)評審和詳細(xì)設(shè)計(jì)評審。在概要設(shè)計(jì)評審過程中，主要詳細(xì)評審每個系統(tǒng)組成部分的基本設(shè)計(jì)方法和測試計(jì)劃。系統(tǒng)規(guī)格說明應(yīng)根據(jù)概要設(shè)計(jì)評審的結(jié)果加以修改。詳細(xì)設(shè)計(jì)評審主要評審計(jì)算機(jī)程序和程序單元測試計(jì)劃。設(shè)計(jì)評審產(chǎn)生的最終文檔規(guī)定系統(tǒng)和程序?qū)⑷绾卧O(shè)計(jì)、開發(fā)和測試，以滿足一致同意的需求。產(chǎn)品文檔的計(jì)劃應(yīng)包括對下述內(nèi)容的評審和認(rèn)可：編排方式；技術(shù)準(zhǔn)確度；復(fù)蓋范圍的完整性；對讀者的適合程度；圖表設(shè)計(jì)思想及最終圖表（也應(yīng)接受關(guān)于技術(shù)準(zhǔn)確度、適合程度和完整性的單獨(dú)評審）；在語法、標(biāo)點(diǎn)及其他行文技巧方面的正確性；對格式和別的標(biāo)準(zhǔn)的遵守程度。評審一般采用評審會的方式進(jìn)行，由軟件開發(fā)單位負(fù)責(zé)人、用戶代表、開發(fā)小組成員、科技管理人員和標(biāo)準(zhǔn)化人員等組成評審小組，必要時還可邀請外單位的希賽網(wǎng)參加。2.GB/T8567-2006GB8567-2006根據(jù)GB/T8566-2001的規(guī)定，主要對軟件的開發(fā)過程和管理過程應(yīng)編制的主要文檔及其編制的內(nèi)容、格式規(guī)定了基本要求。該標(biāo)準(zhǔn)原則上適用于所有類型的軟件產(chǎn)品的開發(fā)過程和管理過程。（1）標(biāo)準(zhǔn)的內(nèi)容GB8567-2006規(guī)定了文檔過程，包括軟件標(biāo)準(zhǔn)的類型（含產(chǎn)品標(biāo)準(zhǔn)和過程標(biāo)準(zhǔn)）、源材料的準(zhǔn)備、文檔計(jì)劃、文檔開發(fā)、評審、與其他公司的文檔開發(fā)子合同；GB8567-2006規(guī)定了軟件生存周期與各種文檔的編制要求，包括可行性與計(jì)劃研究、需求分析、設(shè)計(jì)、實(shí)現(xiàn)、測試、運(yùn)行與維護(hù)共六個階段的要求，以及在文檔編制中應(yīng)考慮的各種因素。GB8567-2006詳細(xì)給出了25種文檔編制的格式（但在文檔的歸類中，卻只給出了其中的18種文檔），包括可行性研究（研究）報告、軟件開發(fā)計(jì)劃、軟件測試計(jì)劃、軟件安裝計(jì)劃、軟件移交計(jì)劃、運(yùn)行概念說明、系統(tǒng)/子系統(tǒng)需求規(guī)格說明、接口需求規(guī)格說明、系統(tǒng)/子系統(tǒng)設(shè)計(jì)（結(jié)構(gòu)設(shè)計(jì)）說明、接口設(shè)計(jì)說明、軟件需求規(guī)格說明、數(shù)據(jù)需求說明、軟件（結(jié)構(gòu)）設(shè)計(jì)說明、數(shù)據(jù)庫（頂層）設(shè)計(jì)說明、軟件測試說明、軟件測試報告、軟件配置管理計(jì)劃、軟件質(zhì)量保證計(jì)劃、開發(fā)進(jìn)度月報、項(xiàng)目開發(fā)總結(jié)報告、軟件產(chǎn)品規(guī)格說明、軟件版本說明、軟件用戶手冊、計(jì)算機(jī)操作手冊、計(jì)算機(jī)編程手冊。GB8567-2006給出了這25種文件的具體內(nèi)容，使用者可根據(jù)實(shí)際情況對該標(biāo)準(zhǔn)進(jìn)行適當(dāng)剪裁。GB8567-2006還規(guī)定了面向?qū)ο蟮能浖?yīng)編制以下文檔：總體說明文檔、用例圖文檔、類圖文檔、順序圖文檔、協(xié)作圖（通信圖）文檔、狀態(tài)圖文檔、活動圖文檔、構(gòu)件圖文檔、部署圖文檔、包圖文檔。（2）文檔的編制軟件生命周期各階段與軟件文檔編制工作的關(guān)系如表4-4所示。表4-4軟件生命周期各階段與軟件文檔編制工作的關(guān)系（3）文檔的使用各類人員與軟件文檔的使用關(guān)系如表4-5所示。表4-5各類人員與軟件文檔的使用關(guān)系（4）文檔的控制在軟件的開發(fā)過程中，隨著程序的逐步形成和逐步修改，各種文件也在不斷地產(chǎn)生、不斷地修改或補(bǔ)充。因此，必須加以周密的控制，以保持文件與程序產(chǎn)品的一致性，保持各種文件之間的一致性和文件的安全性。這種控制表現(xiàn)在以下六個方面：第一，就從事一項(xiàng)軟件開發(fā)工作的開發(fā)集體而言，應(yīng)設(shè)置一位專職的文件管理人員（接口管理工程師或文件管理員）；在開發(fā)集體中，應(yīng)該集中保管本項(xiàng)目現(xiàn)有全部文件的主文本兩套，由該文件管理人員負(fù)責(zé)保管。這兩套主文本的內(nèi)容必須完全一致。其中有一套是可供出借的，另一套是絕對不能出借的，以免發(fā)生萬一；可出借的主文本在出借時必須辦理出借手續(xù)，歸還時辦理注銷出借手續(xù)。第二，每一份提交給文件管理人員的文件都必須具有編寫人、審核人和批準(zhǔn)人的簽字。第三，開發(fā)集體中的工作人員可以根據(jù)工作的需要，在本項(xiàng)目的開發(fā)過程中持有一些文件，即所謂個人文件，包括為使他完成他承擔(dān)的任務(wù)所需要的文件，以及他在完成任務(wù)過程中所編制的文件；但這種個人文件必須是主文本的復(fù)制品，必須同主文本完全一致，若要修改，必須首先修改主文本。第四，不同開發(fā)人員所擁有的個人文件通常是主文本的各種子集；所謂子集是指將主文本的各個部分根據(jù)承擔(dān)不同任務(wù)的人員或部門的工作需要加以復(fù)制、組裝而成的若干個文件的集合；文件管理人員應(yīng)該列出一份不同子集的分發(fā)對象的清單，按照清單及時將文件分發(fā)給有關(guān)人員或部門。第五，一份文件如果已經(jīng)被另一份新的文件所代替，則原文件應(yīng)該被注銷；文件管理人中要隨時整理主文本，及時反映出文件的變化和增加情況，及時分發(fā)文件。第六，當(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é)果。3.GB/T9385-2008GB/T9385-2008詳細(xì)描述了SRS應(yīng)該包含的內(nèi)容及編寫格式。該指南為軟件需求實(shí)踐提供了一個規(guī)范化的方法，不提倡將軟件需求說明劃分成等級，避免將它定義成更小的需求子集。該指南規(guī)定，SRS的內(nèi)容應(yīng)該包括以下四個方面：（1）前言：包括目的、范圍、定義、簡稱和縮略語、引用文件、綜述。（2）總體描述：包括產(chǎn)