1、1.軟件文檔管理指南(GB/t 16680-96)；2.簡(jiǎn)介：本標(biāo)準(zhǔn)為負(fù)責(zé)軟件或基于軟件的產(chǎn)品開(kāi)發(fā)的經(jīng)理提供軟件文檔管理指南。目的是幫助經(jīng)理在他們的組織中產(chǎn)生有效的文件。本標(biāo)準(zhǔn)涉及政策、標(biāo)準(zhǔn)、程序、資源和計(jì)劃。管理者必須注意這些內(nèi)容，以便有效地管理軟件文檔。該標(biāo)準(zhǔn)有望應(yīng)用于各種類型的軟件，從簡(jiǎn)單的程序到復(fù)雜的軟件系統(tǒng)。它將涵蓋各種類型的軟件文檔，并在軟件生命周期的每個(gè)階段發(fā)揮作用。簡(jiǎn)介：不管項(xiàng)目的規(guī)模有多大，軟件文檔管理的原則都是一樣的。對(duì)于小型項(xiàng)目，不得采用本標(biāo)準(zhǔn)中規(guī)定的相關(guān)細(xì)節(jié)。經(jīng)理可以定制這些內(nèi)容以滿足他們的特殊需要。本標(biāo)準(zhǔn)是為文檔編制管理而提出的，不涉及軟件文檔的內(nèi)容和編排。4、參考標(biāo)

2、準(zhǔn)、GB 8566-88計(jì)算機(jī)軟件開(kāi)發(fā)規(guī)范、GB 8567-88計(jì)算機(jī)軟件產(chǎn)品開(kāi)發(fā)文件編制指南、GB/T 11457-1995軟件工程術(shù)語(yǔ)、5、定義、文件A數(shù)據(jù)介質(zhì)和記錄在其上的數(shù)據(jù)。它是永久性的，可以被人或機(jī)器讀取。通常僅用于描述人類可讀的內(nèi)容。例如，技術(shù)文檔、設(shè)計(jì)文檔、版本描述文檔。一個(gè)或多個(gè)相關(guān)文檔的集合。6，定義，文件計(jì)劃文件計(jì)劃描述文件準(zhǔn)備工作方法的管理文件。該計(jì)劃主要描述要準(zhǔn)備什么樣的文件，這些文件的內(nèi)容是什么，何時(shí)、由誰(shuí)以及如何準(zhǔn)備這些文件，以及影響預(yù)期結(jié)果的可用資源和外部因素是什么。7、文件的定義、文件級(jí)別對(duì)所需文件的描述，表明文件的范圍、內(nèi)容、格式和質(zhì)量。文檔級(jí)別可以根據(jù)項(xiàng)目

3、、成本、預(yù)期用途、應(yīng)用范圍或其他因素進(jìn)行選擇。軟件產(chǎn)品的軟件開(kāi)發(fā)過(guò)程的結(jié)果，以及供用戶使用的軟件實(shí)體。8，主要內(nèi)容，軟件文檔的作用，經(jīng)理的作用，文檔準(zhǔn)備策略，文檔準(zhǔn)備標(biāo)準(zhǔn)和指南，文檔準(zhǔn)備計(jì)劃，文檔程序所需的資源，9，軟件文檔的作用，基于質(zhì)量保證的管理，軟件維護(hù)支持，憑證培訓(xùn)和與任務(wù)相關(guān)的參考?xì)v史文件，10，主要內(nèi)容，軟件文檔的作用經(jīng)理的作用制定文檔編譯策略制定文檔編譯標(biāo)準(zhǔn)和指南文檔編譯計(jì)劃制定文檔程序所需的資源；11.經(jīng)理的角色，經(jīng)理嚴(yán)格要求軟件開(kāi)發(fā)人員和編譯團(tuán)隊(duì)完成文檔編譯，并在策略、標(biāo)準(zhǔn)、程序、資源分配和編譯計(jì)劃方面給予支持。12、經(jīng)理對(duì)文件工作的責(zé)任，經(jīng)理應(yīng)認(rèn)識(shí)到正式或非正式文件的重要性

4、，同時(shí)也認(rèn)識(shí)到文件工作必須包括文件的計(jì)劃、編寫、修改、形成、分發(fā)和維護(hù)。13、經(jīng)理對(duì)文件工作的支持，經(jīng)理應(yīng)向編寫文件的人提供指導(dǎo)和實(shí)際鼓勵(lì)，并使各種資源有效地用于文件開(kāi)發(fā)。14、管理者的主要職責(zé)，建立編制、登記和發(fā)布系統(tǒng)文件和軟件文件的各種策略，將文件策劃作為整個(gè)開(kāi)發(fā)工作的一個(gè)組成部分，建立確定文件質(zhì)量的各種方法、測(cè)試質(zhì)量和評(píng)審質(zhì)量的程序，為文件的各個(gè)方面確定和準(zhǔn)備各種標(biāo)準(zhǔn)和指南，積極支持文件工作，形成在開(kāi)發(fā)中自覺(jué)編制文件的團(tuán)隊(duì)精神，不斷檢查已建立的過(guò)程，確保符合政策、各種規(guī)定和符合相關(guān)標(biāo)準(zhǔn)和指南；15.項(xiàng)目經(jīng)理在開(kāi)發(fā)前應(yīng)決定的事項(xiàng)，需要提供哪些類型的文件，需要多少種文件，包括什么類型的文件，

5、產(chǎn)生什么類型的文件，如何保存和維護(hù)文件，以及如何交流；如果軟件合同有效，則應(yīng)要求文件符合公認(rèn)的標(biāo)準(zhǔn)，并應(yīng)規(guī)定所提供文件的類型、每份文件的質(zhì)量水平以及審查和批準(zhǔn)的程序。，16，主要內(nèi)容，軟件文檔的作用，經(jīng)理的作用，文檔準(zhǔn)備策略，文檔準(zhǔn)備標(biāo)準(zhǔn)和指南，文檔準(zhǔn)備計(jì)劃，文檔程序所需的資源，17，文檔準(zhǔn)備策略，由上級(jí)(高級(jí))經(jīng)理準(zhǔn)備和支持，為下級(jí)開(kāi)發(fā)單位或開(kāi)發(fā)人員提供指導(dǎo)。該政策規(guī)定了主要方向，而不是詳細(xì)描述要做什么或如何做。一般來(lái)說(shuō)，文檔策略聲明應(yīng)該是清晰的，向每個(gè)人宣布并被理解，以便他們可以實(shí)施策略。18、支持有效文檔策略的基本條件，文檔需要覆蓋整個(gè)軟件生命周期，文檔在項(xiàng)目的早期階段是必需的，并且必須

6、在整個(gè)軟件開(kāi)發(fā)過(guò)程中可用和可維護(hù)。開(kāi)發(fā)完成后，文件應(yīng)滿足軟件使用、維護(hù)、增強(qiáng)、轉(zhuǎn)換或傳輸?shù)囊蟆Ｎ募?yīng)易于管理，以指導(dǎo)和控制文件的獲取和維護(hù)。管理者和發(fā)布專家應(yīng)準(zhǔn)備詳細(xì)的計(jì)劃大綱，記錄產(chǎn)品、進(jìn)度、可靠性、資源、質(zhì)量保證和評(píng)審程序。19、支持有效文檔策略的基本條件，文檔應(yīng)適合其讀者，如經(jīng)理、分析師、沒(méi)有計(jì)算機(jī)經(jīng)驗(yàn)的專業(yè)人員、維護(hù)人員、文書人員等。根據(jù)任務(wù)的執(zhí)行情況，它們需要不同的材料表示和不同層次的細(xì)節(jié)。對(duì)于不同的讀者，出版專家應(yīng)該負(fù)責(zé)設(shè)計(jì)不同類型的文檔。文檔效應(yīng)應(yīng)貫穿軟件開(kāi)發(fā)的全過(guò)程，并應(yīng)充分體現(xiàn)文檔的功能和局限性，即文檔應(yīng)指導(dǎo)整個(gè)開(kāi)發(fā)過(guò)程。20、支持有效文件策略的基本條件，文件標(biāo)準(zhǔn)應(yīng)被識(shí)別和

7、使用，并應(yīng)盡可能采用現(xiàn)行標(biāo)準(zhǔn)。如果沒(méi)有合適的現(xiàn)行標(biāo)準(zhǔn)，必要時(shí)應(yīng)制定適用的標(biāo)準(zhǔn)或指南。應(yīng)該指定支持工具來(lái)幫助開(kāi)發(fā)和維護(hù)軟件產(chǎn)品，包括文檔。因此，盡可能多地使用工具是經(jīng)濟(jì)可行的。21，主要內(nèi)容，軟件文檔的作用，管理者的作用，文檔準(zhǔn)備策略，文檔準(zhǔn)備標(biāo)準(zhǔn)和指南，文檔準(zhǔn)備計(jì)劃，文檔程序所需的資源，22，文檔準(zhǔn)備標(biāo)準(zhǔn)和指南，應(yīng)在組織內(nèi)采用：軟件生命周期模型，文檔類型和相互關(guān)系，文檔質(zhì)量。這些標(biāo)準(zhǔn)和準(zhǔn)則將決定如何完成文檔任務(wù)，并提供一些準(zhǔn)則來(lái)評(píng)估組織內(nèi)生成的軟件文檔的完整性、可用性和適用性。應(yīng)盡可能采用現(xiàn)有的國(guó)家和國(guó)際標(biāo)準(zhǔn)。如果現(xiàn)有標(biāo)準(zhǔn)不適用，各機(jī)構(gòu)應(yīng)制定自己的標(biāo)準(zhǔn)。23，1。選擇軟件生命周期模型。一些現(xiàn)有

8、的軟件生命周期模型對(duì)于不同的階段有不同的詞匯。從軟件文檔的角度來(lái)看，采用哪種模型并不重要，只要階段和相應(yīng)的文檔被清晰地定義和規(guī)劃，并且可以被任何特定的軟件項(xiàng)目所遵循。因此，管理者應(yīng)該選擇一個(gè)軟件生命周期模型，并確保該模型適用于他們的組織。管理者會(huì)發(fā)現(xiàn)階段和任務(wù)的定義有助于監(jiān)控軟件項(xiàng)目的進(jìn)度。特定階段對(duì)應(yīng)生成的文件可以作為該階段審核、通過(guò)和完成的檢查點(diǎn)，該檢查應(yīng)在下一階段開(kāi)始前進(jìn)行。24，2。規(guī)定了文檔的類型和內(nèi)容，軟件文檔分為以下三類：描述開(kāi)發(fā)過(guò)程本身的開(kāi)發(fā)文檔；產(chǎn)品文檔描述了產(chǎn)品的開(kāi)發(fā)過(guò)程；管理文件記錄了項(xiàng)目管理的信息。25，(1)開(kāi)發(fā)文檔是一種描述軟件開(kāi)發(fā)過(guò)程的文檔，包括軟件需求、軟件設(shè)計(jì)

9、、軟件測(cè)試和軟件質(zhì)量保證。開(kāi)發(fā)文檔還包括軟件的詳細(xì)技術(shù)描述(程序邏輯、程序之間的相互關(guān)系、數(shù)據(jù)格式和存儲(chǔ)等)。)。26.開(kāi)發(fā)文檔的功能是在軟件開(kāi)發(fā)過(guò)程的所有階段之間的通信工具，它記錄和生成軟件需求、設(shè)計(jì)和編碼。通過(guò)定義軟件的角色，如果開(kāi)發(fā)文檔丟失、不完整或過(guò)時(shí)，管理者將失去一個(gè)跟蹤和控制軟件項(xiàng)目的重要工具。形成維護(hù)人員所需的基本軟件支持文檔，這些支持文檔可以作為產(chǎn)品文檔的一部分；記錄軟件開(kāi)發(fā)的歷史。27、基本開(kāi)發(fā)文件、可行性研究和項(xiàng)目規(guī)范要求規(guī)范功能規(guī)范設(shè)計(jì)規(guī)范，包括程序和數(shù)據(jù)規(guī)范開(kāi)發(fā)計(jì)劃軟件集成和測(cè)試計(jì)劃質(zhì)量保證計(jì)劃、標(biāo)準(zhǔn)、進(jìn)度安全和測(cè)試信息、28、(2)產(chǎn)品文件、產(chǎn)品文件規(guī)定關(guān)于軟件產(chǎn)品的

10、使用、維護(hù)、增強(qiáng)、轉(zhuǎn)換和傳輸?shù)男畔?。產(chǎn)品文檔起到以下三個(gè)作用：為任何使用和運(yùn)行軟件產(chǎn)品的人提供培訓(xùn)和參考信息，以便不參與該軟件開(kāi)發(fā)的程序員能夠維護(hù)它，促進(jìn)軟件產(chǎn)品的市場(chǎng)流通或提高可接受性。產(chǎn)品文檔用于用戶、操作員和軟件維護(hù)人員。管理人員指南和材料是用于監(jiān)督軟件使用的宣傳材料，用于宣布軟件產(chǎn)品的可用性并詳細(xì)解釋其功能、運(yùn)行環(huán)境和其他一般信息，還用于向任何感興趣的人描述軟件產(chǎn)品。30.基本產(chǎn)品文檔、培訓(xùn)手冊(cè)、參考手冊(cè)和用戶指南、軟件支持手冊(cè)、產(chǎn)品手冊(cè)和信息廣告，31。(3)管理文件，此類文件基于項(xiàng)目管理信息。開(kāi)發(fā)過(guò)程每個(gè)階段的進(jìn)展和進(jìn)展變化記錄。軟件變更的記錄與開(kāi)發(fā)的判斷記錄相關(guān)。職責(zé)從管理的角度

11、定義與軟件生存相關(guān)的信息。32.相關(guān)知識(shí)、軟件文檔的分類、軟件文檔和用戶之間的關(guān)系，以及軟件生命周期各階段和各種文檔回答的問(wèn)題。33.文件的質(zhì)量水平。僅根據(jù)法規(guī)、傳統(tǒng)慣例或合同要求制作文件是不夠的。管理者還必須確定文件的質(zhì)量要求，以及如何實(shí)現(xiàn)和確保質(zhì)量要求。質(zhì)量要求的確定取決于可用的資源、項(xiàng)目規(guī)模和風(fēng)險(xiǎn)，并且產(chǎn)品的每個(gè)文件的格式和細(xì)節(jié)都可以清楚地定義。在文檔規(guī)劃過(guò)程中，必須清楚地定義每個(gè)文檔的質(zhì)量。根據(jù)文件的形式和列出的要求，文件的質(zhì)量可分為四個(gè)等級(jí)。34，級(jí)別1文檔，最小文檔適合開(kāi)發(fā)工作量少于一個(gè)人工月的開(kāi)發(fā)人員自己的程序。該文檔應(yīng)包括程序列表、開(kāi)發(fā)記錄、測(cè)試數(shù)據(jù)和程序介紹、35級(jí)和2級(jí)文檔

12、，內(nèi)部文檔可用于經(jīng)過(guò)仔細(xì)研究后似乎沒(méi)有與其他用戶共享資源的特殊程序。除了1級(jí)文檔提供的信息外，2級(jí)文檔還在程序列表中包含足夠的注釋，以幫助用戶安裝和使用程序。36、3級(jí)文檔、工作文檔適用于由同一公司的幾個(gè)人共同開(kāi)發(fā)的程序，或者可以被其他公司使用的程序。37，4級(jí)文檔，正式文檔適用于正式發(fā)布供一般使用的軟件產(chǎn)品。關(guān)鍵程序或具有重復(fù)管理應(yīng)用屬性的程序(如薪資計(jì)算)需要四級(jí)文件，應(yīng)符合國(guó)標(biāo)8567的相關(guān)規(guī)定。38.文件質(zhì)量，質(zhì)量中要考慮的問(wèn)題應(yīng)該包括文件的結(jié)構(gòu)和內(nèi)容。文檔內(nèi)容可以根據(jù)正確性、完整性和清晰性來(lái)判斷，文檔結(jié)構(gòu)由每個(gè)組件的順序和整體布局的簡(jiǎn)單性來(lái)決定。為了達(dá)到這四個(gè)質(zhì)量等級(jí)，所需的投資和資

13、源將逐步增加，質(zhì)量保證機(jī)構(gòu)必須處于適當(dāng)?shù)墓芾淼匚?，以確保達(dá)到預(yù)期的質(zhì)量等級(jí)。39，主要內(nèi)容，軟件文檔的作用，管理者的作用，文檔準(zhǔn)備策略，文檔準(zhǔn)備標(biāo)準(zhǔn)和指南，文檔準(zhǔn)備計(jì)劃，文檔程序所需的資源，40，文檔準(zhǔn)備計(jì)劃，文檔計(jì)劃可以是整個(gè)項(xiàng)目計(jì)劃的一部分或獨(dú)立的文檔。應(yīng)準(zhǔn)備一份文檔計(jì)劃并分發(fā)給開(kāi)發(fā)團(tuán)隊(duì)的所有成員，作為文檔重要性的具體依據(jù)，以及一份關(guān)于管理部門文檔工作職責(zé)的備忘錄。對(duì)于小型和非正式項(xiàng)目，文件計(jì)劃可能只有一頁(yè)；對(duì)于較大的項(xiàng)目，文件計(jì)劃可能是一個(gè)全面的正式文件，它應(yīng)該遵循嚴(yán)格的標(biāo)準(zhǔn)和正式的審查和批準(zhǔn)過(guò)程。41.記錄計(jì)劃的準(zhǔn)備情況。計(jì)劃的編制應(yīng)盡早開(kāi)始，對(duì)計(jì)劃的審查應(yīng)貫穿項(xiàng)目的整個(gè)過(guò)程。像任何其

14、他計(jì)劃一樣，文件計(jì)劃指明了未來(lái)的活動(dòng)，必要時(shí)必須進(jìn)行修改。導(dǎo)致對(duì)計(jì)劃進(jìn)行適當(dāng)修改的例行審查應(yīng)作為項(xiàng)目工作的一部分，與計(jì)劃相關(guān)的所有人員應(yīng)獲得文件計(jì)劃。42.文件計(jì)劃的主要內(nèi)容，列出需要編制的文件目錄，提示編制文件時(shí)需要參考的標(biāo)準(zhǔn)，指定文件管理員為編制文件提供必要的條件，實(shí)施文件編寫人、所需經(jīng)費(fèi)、編制工具等方法，明確保證文件質(zhì)量。為保證文件內(nèi)容的正確性和合理性，應(yīng)采取一定的措施，如制定評(píng)審時(shí)間表，列出文件、編寫人、編寫日期、完成日期、評(píng)審日期等。應(yīng)該在軟件生命周期的每個(gè)階段以圖表的形式產(chǎn)生。文件計(jì)劃主要內(nèi)容，此外，文件計(jì)劃規(guī)定了每個(gè)文件要達(dá)到的質(zhì)量水平，以及為了達(dá)到預(yù)期的結(jié)果必須考慮哪些外部因素

15、。文件計(jì)劃還決定了計(jì)劃和文件的分發(fā)，并清楚地描述了所有使用文件的人員的職責(zé)。44，主要內(nèi)容，軟件文檔的作用，管理者的作用，文檔準(zhǔn)備策略，文檔準(zhǔn)備標(biāo)準(zhǔn)和指南，文檔準(zhǔn)備計(jì)劃，文檔程序所需的資源，45，文檔準(zhǔn)備程序，其應(yīng)符合上述文檔策略并適用于整個(gè)軟件產(chǎn)品生命周期中的文檔準(zhǔn)備和使用，提出了文檔計(jì)劃、準(zhǔn)備、審查、生產(chǎn)和分發(fā)的邏輯順序。這些程序包括批準(zhǔn)、質(zhì)量保證和幾個(gè)控制點(diǎn)，并概述修改步驟、儲(chǔ)存和維護(hù)要求以及更新方法。46、制定文件規(guī)定、文件計(jì)劃、文件編號(hào)、審查文件、簽署文件、歸檔和保存文件、47、1、文件計(jì)劃，一旦項(xiàng)目得到確認(rèn)，應(yīng)制定項(xiàng)目開(kāi)發(fā)計(jì)劃(包括文件計(jì)劃),文件計(jì)劃應(yīng)符合上述規(guī)定；48、2、文件

16、準(zhǔn)備是一項(xiàng)非常詳細(xì)的工作，自文件準(zhǔn)備大綱首次提出以來(lái)，已逐步得到豐富和改進(jìn)；49、文件準(zhǔn)備的注意事項(xiàng)、文件準(zhǔn)備時(shí)間應(yīng)與軟件開(kāi)發(fā)同步，相應(yīng)的文件準(zhǔn)備應(yīng)在軟件生命周期的每個(gè)階段完成文件應(yīng)按文件計(jì)劃中規(guī)定的文件數(shù)量和質(zhì)量要求編制，相應(yīng)的文件應(yīng)按國(guó)標(biāo)8567或單位規(guī)定的標(biāo)準(zhǔn)內(nèi)容格式編制。文件的紙質(zhì)格式應(yīng)由各單位按照相關(guān)標(biāo)準(zhǔn)執(zhí)行。每份文件都必須裝訂成冊(cè)。文件的封面和歸檔內(nèi)容也應(yīng)有標(biāo)題頁(yè)，供所有負(fù)責(zé)人簽名。50，3。文件編號(hào)。為便于管理，軟件文檔應(yīng)按照編號(hào)方法進(jìn)行編號(hào)，如十進(jìn)制分類、成員法等。每個(gè)單元可以根據(jù)其實(shí)際情況確定一種編號(hào)方法，編號(hào)應(yīng)該是唯一的。51，十進(jìn)制分類，十進(jìn)制分類編號(hào)方法。該方法是將產(chǎn)品

17、設(shè)計(jì)文件按照規(guī)定的技術(shù)特征(功能、結(jié)構(gòu)、材料、用途和工藝特征)分為10個(gè)層次，每個(gè)層次分為10個(gè)類別，每個(gè)類別又分為10種類型，每種類型又分為10種類型。在特征標(biāo)記前，用漢語(yǔ)拼音表示企業(yè)標(biāo)識(shí)碼，在特征標(biāo)記后，用三位數(shù)字表示注冊(cè)號(hào)，最后是文件縮寫號(hào)。示例： ab 2 . 022 . 005 mxa b 2 . 022 . 005 MX企業(yè)代碼級(jí)別類型注冊(cè)序號(hào)文件簡(jiǎn)要編號(hào)52，成員編號(hào)方法，成員編號(hào)，即根據(jù)成員關(guān)系，下屬編號(hào)應(yīng)在其上級(jí)范圍內(nèi)編號(hào)53，4。為了提高軟件產(chǎn)品的質(zhì)量，文檔評(píng)審是非常重要的，必須與技術(shù)評(píng)審相結(jié)合。一個(gè)有效的方法是對(duì)軟件開(kāi)發(fā)的各個(gè)階段形成的文檔進(jìn)行嚴(yán)格的評(píng)審，以便盡早發(fā)現(xiàn)問(wèn)題，及時(shí)采取措施解決問(wèn)題，從而保證文檔內(nèi)容的正確性，避免或減少重大返工，為進(jìn)入下一階段做好組織和技術(shù)準(zhǔn)備。54，文檔審查，對(duì)于一些大型項(xiàng)目，正式的審查通常是在開(kāi)發(fā)方法論的指導(dǎo)下進(jìn)行的。正式審查應(yīng)包