軟件文檔指南電子教案

軟件文檔管理指南引用標(biāo)準(zhǔn)GB8566-88計算機軟件開發(fā)規(guī)范GB8567-88計算機軟件產(chǎn)品開發(fā)文件編制指南GB/T11457-1995軟件工程術(shù)語2定義文檔document

一種數(shù)據(jù)媒體和其上所記錄的數(shù)據(jù)。它具有永久性并可以由人或機器閱讀。通常僅用于描述人工可讀的內(nèi)容。例如，技術(shù)文件、設(shè)計文件、版本說明文件。文檔（集）/文檔編制documentation一個或多個相關(guān)文檔的集合。3定義文檔計劃documentationplan一個描述文檔編制工作方法的管理用文檔。該計劃主要描述要編制什么類型的文檔，這些文檔的內(nèi)容是什么，何時編寫，由誰編寫，如何編寫，以及什么是影響期望結(jié)果的可用資源和外界因素。4定義文檔等級levelofdocumentation

對所需文檔的一個說明，它指出文檔的范圍、內(nèi)容、格式及質(zhì)量，可以根據(jù)項目、費用、預(yù)期用途、作用范圍或其他因素選擇文檔等級。軟件產(chǎn)品softwareproduct軟件開發(fā)過程的結(jié)果，并推出供用戶使用的軟件實體。5主要內(nèi)容軟件文檔的作用管理者的作用制訂文檔編制策略制訂文檔編制標(biāo)準(zhǔn)和指南文檔編制計劃制訂文檔規(guī)程所需資源6軟件文檔的作用管理依據(jù)質(zhì)量保證軟件維護支持任務(wù)之間聯(lián)系的憑證培訓(xùn)與參考歷史檔案7主要內(nèi)容軟件文檔的作用管理者的作用制訂文檔編制策略制訂文檔編制標(biāo)準(zhǔn)和指南文檔編制計劃制訂文檔規(guī)程所需資源8管理者的作用管理者嚴(yán)格要求軟件開發(fā)人員和編制組完成文檔編制，并且在策略、標(biāo)準(zhǔn)、規(guī)程、資源分配和編制計劃方面給予支持。9管理者對文檔工作的責(zé)任管理者要認識到正式或非正式文檔都是重要的，還要認識到文檔工作必須包括文檔計劃、編寫、修改、形成、分發(fā)和維護等各個方面。10管理者對文檔工作的支持管理者應(yīng)為編寫文檔的人員提供指導(dǎo)和實際鼓勵，并使各種資源有效地用于文檔開發(fā)。11管理者的主要職責(zé)建立編制、登記、出版系統(tǒng)文檔和軟件文檔的各種策略把文檔計劃作為整個開發(fā)工作的一個組成部分建立確定文檔質(zhì)量、測試質(zhì)量和評審質(zhì)量各種方法的規(guī)程為文檔的各個方面確定和準(zhǔn)備各種標(biāo)準(zhǔn)和指南積極支持文檔工作以形成開發(fā)中自覺編制文檔的團隊風(fēng)氣不斷檢查已建立起來的過程，以保證符合策略和各種規(guī)程并遵守有關(guān)標(biāo)準(zhǔn)和指南12項目管理者在開發(fā)前應(yīng)決定的事項要求哪些類型的文檔提供多少種文檔文檔包含的內(nèi)容達到何種級別的質(zhì)量水平何時產(chǎn)生何種文檔如何保存、維護文檔以及如何進行通信如果一個軟件合同是有效的，應(yīng)要求文檔滿足所接受的標(biāo)準(zhǔn)，并規(guī)定所提供的文檔類型、每種文檔的質(zhì)量水平以及評審和通過的規(guī)程。13主要內(nèi)容軟件文檔的作用管理者的作用制訂文檔編制策略制訂文檔編制標(biāo)準(zhǔn)和指南文檔編制計劃制訂文檔規(guī)程所需資源14制訂文檔編制策略文檔策略由上級(資深)管理者準(zhǔn)備并支持，對下級開發(fā)單位或開發(fā)人員提供指導(dǎo)。策略規(guī)定主要的方向，不是做什么或如何做的詳細說明。一般說來，文檔編制策略陳述要明確，并通告到每個人且理解它，進而使策略被他們貫徹實施。15支持有效文檔策略的基本條件文檔需要覆蓋整個軟件生存期在項目早期幾個階段就要求有文檔，而且在貫穿軟件開發(fā)過程中必須是可用的和可維護的。在開發(fā)完成后，文檔應(yīng)滿足軟件的使用、維護、增強、轉(zhuǎn)換或傳輸。文檔應(yīng)是可管理的指導(dǎo)和控制文檔的獲得和維護，管理者和發(fā)行專家應(yīng)準(zhǔn)備文檔產(chǎn)品、進度、可靠性、資源，質(zhì)量保證和評審規(guī)程的詳細計劃大綱。16支持有效文檔策略的基本條件文檔應(yīng)適合于它的讀者讀者可能是管理者、分析員、無計算機經(jīng)驗的專業(yè)人員、維護人員、文書人員等。根據(jù)任務(wù)的執(zhí)行，他們要求不同的材料表示和不同的詳細程度。針對不同的讀者，發(fā)行專家應(yīng)負責(zé)設(shè)計不同類型的文檔。文檔效應(yīng)應(yīng)貫穿到軟件的整個開發(fā)過程中在軟件開發(fā)的整個過程中，應(yīng)充分體現(xiàn)文檔的作用和限制，即文檔應(yīng)指導(dǎo)全部開發(fā)過程。17支持有效文檔策略的基本條件文檔標(biāo)準(zhǔn)應(yīng)被標(biāo)識和使用應(yīng)盡可能地采納現(xiàn)行的標(biāo)準(zhǔn)，若沒有合適的現(xiàn)行標(biāo)準(zhǔn)，必要時應(yīng)研制適用的標(biāo)準(zhǔn)或指南。應(yīng)規(guī)定支持工具工具有助于開發(fā)和維護軟件產(chǎn)品，包括文檔。因此盡可能地使用工具是經(jīng)濟的、可行的。18主要內(nèi)容軟件文檔的作用管理者的作用制訂文檔編制策略制訂文檔編制標(biāo)準(zhǔn)和指南文檔編制計劃制訂文檔規(guī)程所需資源19制訂文檔編制標(biāo)準(zhǔn)和指南在一個機構(gòu)內(nèi)部，應(yīng)采用一些標(biāo)準(zhǔn)和指南：軟件生存期模型文檔類型和相互關(guān)系文檔質(zhì)量這些標(biāo)準(zhǔn)和指南將決定如何實現(xiàn)文檔任務(wù)，將提供一些準(zhǔn)則以評價該機構(gòu)內(nèi)所產(chǎn)生的軟件文檔的完整性、可用性和適合性。盡可能地采用現(xiàn)行的國家和國際標(biāo)準(zhǔn)，若現(xiàn)行的標(biāo)準(zhǔn)不適用，機構(gòu)應(yīng)制訂自己的標(biāo)準(zhǔn)。201.選擇軟件生存期模型現(xiàn)有的一些軟件生存期模型，對于不同階段有不同的詞匯。從軟件文檔的觀點來看，采用哪種模型都無關(guān)緊要，只要階段和相應(yīng)文檔是清晰定義的、已計劃的，并且對于任何具體軟件項目是能遵循的。因此，管理者應(yīng)選擇一個軟件生存期模型并保證該模型在他們機構(gòu)內(nèi)是適用的。管理者將會發(fā)現(xiàn)所進行的階段和相應(yīng)任務(wù)的定義有助于監(jiān)控軟件項目的進展。相應(yīng)于特定階段生成的文檔可用作該階段的評審、通過和完成的檢驗點，而這種檢驗應(yīng)在下一階段開始前進行。212.規(guī)定文檔類型和內(nèi)容軟件文檔歸入如下三種類別：開發(fā)文檔——描述開發(fā)過程本身；產(chǎn)品文檔——描述開發(fā)過程的產(chǎn)物；管理文檔——記錄項目管理的信息。22(1)開發(fā)文檔開發(fā)文檔是描述軟件開發(fā)過程，包括軟件需求、軟件設(shè)計、軟件測試、保證軟件質(zhì)量的一類文檔，開發(fā)文檔也包括軟件的詳細技術(shù)描述(程序邏輯、程序間相互關(guān)系、數(shù)據(jù)格式和存儲等)23開發(fā)文檔的作用是軟件開發(fā)過程所有階段間的通信工具，它記錄生成軟件需求、設(shè)計、編碼和測試的詳細規(guī)定和說明描述開發(fā)小組的職責(zé)。通過規(guī)定軟件、主題事項、文檔編制、質(zhì)量保證人員以及包含在開發(fā)過程中任何其他事項的角色來定義做什么，如何做和何時做用作檢驗點而允許管理者評定開發(fā)進度。如果開發(fā)文檔丟失、不完整或過時，管理者將失去跟蹤和控制軟件項目的一個重要工具；形成了維護人員所要求的基本的軟件支持文檔，而這些支持文檔可作為產(chǎn)品文檔的一部分；記錄軟件開發(fā)的歷史。24基本的開發(fā)文檔可行性研究和項目任務(wù)書需求規(guī)格說明功能規(guī)格說明設(shè)計規(guī)格說明，包括程序和數(shù)據(jù)規(guī)格說明開發(fā)計劃軟件集成和測試計劃質(zhì)量保證計劃、標(biāo)準(zhǔn)、進度安全和測試信息25(2)產(chǎn)品文檔產(chǎn)品文檔規(guī)定關(guān)于軟件產(chǎn)品的使用、維護、增強、轉(zhuǎn)換和傳輸?shù)男畔a(chǎn)品的文檔起到如下三種作用為使用運行軟件產(chǎn)品的任何人規(guī)定培訓(xùn)和參考信息使得那些未參加開發(fā)本軟件的程序員維護它促進軟件產(chǎn)品的市場流通或提高可接受性產(chǎn)品文檔用于用戶、運行者和軟件維護人員26產(chǎn)品文檔內(nèi)容用于管理者的指南和資料它們是用來監(jiān)督軟件的使用的宣傳資料用于通告軟件產(chǎn)品的可用性并詳細說明它的功能、運行環(huán)境等一般信息用來對任何有興趣的人描述軟件產(chǎn)品27基本的產(chǎn)品文檔培訓(xùn)手冊參考手冊和用戶指南軟件支持手冊產(chǎn)品手冊和信息廣告28(3)管理文檔這種文檔建立在項目管理信息的基礎(chǔ)上開發(fā)過程每個階段的進度和進度變更的記錄軟件變更情況的記錄相對于開發(fā)的判定記錄職責(zé)定義從管理的角度規(guī)定涉及軟件生存的信息29相關(guān)知識軟件文檔分類軟件文檔與使用者的關(guān)系軟件生存周期各階段與各種文檔編制的關(guān)系文檔所回答的問題303.文檔的質(zhì)量等級僅僅依據(jù)規(guī)章、傳統(tǒng)的做法或合同的要求去制作文檔是不夠的。管理者還必須確定文檔的質(zhì)量要求以及如何達到和保證質(zhì)量要求。質(zhì)量要求的確定取決于可得到的資源、項目的大小和風(fēng)險，可以對該產(chǎn)品的每個文檔的格式及詳細程度作出明確的規(guī)定。每個文檔的質(zhì)量必須在文檔計劃期間就有明確的規(guī)定。文檔的質(zhì)量可以按文檔的形式和列出的要求劃分為四級。311級文檔最低限度文檔適合開發(fā)工作量低于一個人月的開發(fā)者自用程序。該文檔應(yīng)包含程序清單、開發(fā)記錄、測試數(shù)據(jù)和程序簡介322級文檔內(nèi)部文檔可用于在精心研究后被認為似乎沒有與其他用戶共享資源的專用程序。除1級文檔提供的信息外，2級文檔還包括程序清單內(nèi)足夠的注釋以幫助用戶安裝和使用程序。333級文檔工作文檔適于由同單位若干人聯(lián)合開發(fā)的程序，或可被其他單位使用的程序。344級文檔正式文檔適于要正式發(fā)行供普遍使用的軟件產(chǎn)品。關(guān)鍵性程序或具有重復(fù)管理應(yīng)用性質(zhì)(如工資計算)的程序需4級文檔應(yīng)遵守GB8567的有關(guān)規(guī)定35文檔質(zhì)量質(zhì)量方面需要考慮的問題即要包含文檔的結(jié)構(gòu)，也要包含文檔的內(nèi)容。文檔內(nèi)容可根據(jù)正確性、完整性和明確性來判斷文檔結(jié)構(gòu)由各個組成部分的順序和總體安排的簡單性來測定。要達到這四個質(zhì)量等級，需要的投入和資源逐級增加，質(zhì)量保證機構(gòu)必須處于適當(dāng)?shù)男姓匚灰员ＷC達到期望的質(zhì)量等級。36主要內(nèi)容軟件文檔的作用管理者的作用制訂文檔編制策略制訂文檔編制標(biāo)準(zhǔn)和指南文檔編制計劃制訂文檔規(guī)程所需資源37文檔編制計劃文檔計劃可以是整個項目計劃的一部分或是一個獨立的文檔。應(yīng)該編寫文檔計劃并把它分發(fā)給全體開發(fā)組成員，作為文檔重要性的具體依據(jù)和管理部門文檔工作責(zé)任的備忘錄對于小的、非正式的項目，文檔計劃可能只有一頁紙；對于較大的項目，文檔計劃可能是一個綜合性的正式文檔，這樣的文檔計劃應(yīng)遵循各項嚴(yán)格的標(biāo)準(zhǔn)及正規(guī)的評審和批準(zhǔn)過程。

38文檔編制計劃編制計劃的工作應(yīng)及早開始，對計劃的評審應(yīng)貫穿項目的全過程。如同任何別的計劃一樣，文檔計劃指出未來的各項活動，當(dāng)需要修改時必須加以修改。導(dǎo)致對計劃作適當(dāng)修改的常規(guī)評審應(yīng)作為該項目工作的一部分，所有與該計劃有關(guān)的人員都應(yīng)得到文檔計劃39文檔計劃主要內(nèi)容列出應(yīng)編制文檔的目錄提示編制文檔應(yīng)參考的標(biāo)準(zhǔn)指定文檔管理員提供編制文檔所需要的條件，落實文檔編寫人員、所需經(jīng)費以及編制工具等明確保證文檔質(zhì)量的方法，為確保文檔內(nèi)容的正確性、合理性，應(yīng)采取一定的措施，如評審、鑒定等繪制進度表，以圖表形式列出在軟件生存期各階段應(yīng)產(chǎn)生的文檔、編制人員、編制日期、完成日期、評審日期等。40文檔計劃主要內(nèi)容此外，文檔計劃規(guī)定每個文檔要達到的質(zhì)量等級，以及為了達到期望的結(jié)果必須考慮哪些外部因素。文檔計劃還確定該計劃和文檔的分發(fā)，并且明確敘述與文檔工作的所有人員的職責(zé)。41主要內(nèi)容軟件文檔的作用管理者的作用制訂文檔編制策略制訂文檔編制標(biāo)準(zhǔn)和指南文檔編制計劃制訂文檔規(guī)程所需資源42制訂文檔規(guī)程文檔編制規(guī)程應(yīng)符合前述文檔策略，并適用于整個軟件產(chǎn)品生存期內(nèi)文檔的編制和使用這些規(guī)程提出關(guān)于文檔的計劃、編制、評審、制作和分發(fā)的邏輯順序。這些規(guī)程內(nèi)含審批、質(zhì)量保證及若干控制點，概述修改步驟、存儲和維護要求以及更新方法。43制訂文檔規(guī)程文檔計劃制定文檔編寫文檔編號文檔評審文檔簽署文檔歸檔與保管文檔維護

441.文檔計劃制定項目一旦確定，就應(yīng)制定項目開發(fā)計劃(包括文檔計劃)，文檔計劃的制定遵照前述規(guī)定452.文檔編寫文檔的編寫是件非常細致的工作，從最初提出文檔編寫提綱開始，經(jīng)過逐步充實、完善，并經(jīng)反復(fù)檢查和修改，直至正式交付使用為止。46文檔編寫注意要點文檔編寫時間應(yīng)與軟件開發(fā)同步，在軟件生存期的每一個階段都應(yīng)完成相應(yīng)的文檔編寫工作按文檔計劃規(guī)定的文檔數(shù)量和質(zhì)量要求編寫文檔按GB8567或本單位指定標(biāo)準(zhǔn)內(nèi)容格式編寫相應(yīng)文檔文檔用紙的格式由各單位按有關(guān)標(biāo)準(zhǔn)規(guī)定執(zhí)行每個文檔必須裝訂成冊，并加封面和目次歸檔用的文檔還應(yīng)有扉頁，用于各責(zé)任者的簽署473.文檔編號為便于管理，軟件文檔應(yīng)按編號法進行編號編號方法有十進分類法、隸屬法等等，各單位可根據(jù)本單位實際情況確定一種編號方法不論何種方法，編號應(yīng)具有唯一性。48十進分類法十進分類編號方法。這種方法就是將產(chǎn)品的設(shè)計文件按規(guī)定的技術(shù)特征（功能、結(jié)構(gòu)、材料、用途、工藝特征），分為10級，每級分為10類，每類分為10型，每型又分為10種。在特征標(biāo)記前，冠以漢語拼音字母表示企業(yè)區(qū)分代號，在特征標(biāo)記后，標(biāo)上三位數(shù)字，表示登記號，最后是文件簡號。例:AB2.022.005MX

AB

2.022

.005

MX

企業(yè)代號

級類型種

登記順序號

文件簡號

49隸屬編號法隸屬編號,即按隸屬關(guān)系編號,下級編號應(yīng)在其所屬上級的范圍內(nèi)編號504.文檔評審文檔評審十分重要，必須與技術(shù)評審結(jié)合起來為了提高軟件產(chǎn)品的質(zhì)量，一個有效的方法就是在軟件開發(fā)的每個階段，對該階段所形成的文檔進行嚴(yán)格的評審，這樣可盡早發(fā)現(xiàn)問題，并及時采取措施予以解決，從而確保文檔內(nèi)容的正確性，避免或減少大的返工，同時為進入下一階段的工作做好組織上和技術(shù)上的準(zhǔn)備。51文檔評審對一些大項目，正規(guī)評審?fù)ǔＴ陂_發(fā)方法學(xué)指導(dǎo)下進行。正規(guī)評審應(yīng)包括文檔評審，這是為了保證文檔不但正確，而且內(nèi)容是最新的。如果對文檔與開發(fā)工作的其他方面同樣重要這一點強調(diào)不夠，各種問題可能隨之而來。對所有描述開發(fā)工作和產(chǎn)品的文檔進行評審是正規(guī)評審過程的組成部分。一開始特別重要的是需求規(guī)格說明和設(shè)計規(guī)格說明的評審。52(1)需求評審需求評審進一步確認開發(fā)者和設(shè)計者已了解用戶要求什么，及用戶從開發(fā)者一方了解某些限制和約束。需求評審(可能需要一次以上)產(chǎn)生一個被認可的需求規(guī)格說明?；趯ο到y(tǒng)要做些什么的共同理解，才能著手詳細設(shè)計。用戶代表必須積極參與開發(fā)和需求評審，參與對需求文檔的認可。53(2)設(shè)計評審?fù)ǔ０才艃蓚€主要的設(shè)計評審概要設(shè)計評審在概要設(shè)計評審過程中，主要詳細評審每個系統(tǒng)組成部分的基本設(shè)計方法和測試計劃。系統(tǒng)規(guī)格說明應(yīng)根據(jù)概要設(shè)計評審的結(jié)果加以修改詳細設(shè)計評審主要評審計算機程序和程序單元測試計劃54設(shè)計評審設(shè)計評審產(chǎn)生的最終文檔規(guī)定系統(tǒng)和程序?qū)⑷绾卧O(shè)計、開發(fā)和測試，以滿足一致同意的需求。正規(guī)備忘錄提供一份有關(guān)所有會議的記錄。55(3)其他評審其他文檔的正規(guī)評審也是必需的。產(chǎn)品文檔的計劃應(yīng)包括對下述內(nèi)容的評審和認可：編排方式技術(shù)準(zhǔn)確度復(fù)蓋范圍的完整性對讀者的適合程度圖表設(shè)計思想及最終圖表(也應(yīng)接受關(guān)于技術(shù)準(zhǔn)確度、適合程度和完整性的單獨評審)在語法、標(biāo)點及其他行文技巧方面的正確性對格式和別的標(biāo)準(zhǔn)的遵守程度56評審會步驟由軟件開發(fā)單位負責(zé)人、用戶代表、開發(fā)小組成員、科技管理人員和標(biāo)準(zhǔn)化人員等組成評審小組，必要時還可邀請外單位的專家參加；開會前由開發(fā)單位負責(zé)人確定評審的具體內(nèi)容，并將評審材料發(fā)給評審小組成員，要求做好評審準(zhǔn)備由開發(fā)單位負責(zé)人主持評審會，根據(jù)文檔編制者對該文檔的說明和評審條目，由評審小組成員進行評議、評審，評審結(jié)束應(yīng)作出評審結(jié)論，評審小組成員應(yīng)在評審結(jié)論上簽字。575.文檔簽署軟件產(chǎn)品的所有文檔，都應(yīng)按規(guī)定進行簽署軟件文檔簽署的順序一般按“編寫一審核－會簽－標(biāo)準(zhǔn)化－批準(zhǔn)”的順序進行。會簽僅在必要時才進行。簽署不允許代簽。修改單的簽署與被修改的文檔簽署相同。注：會簽是撰擬公文的過程中，主辦單位主動與有關(guān)單位協(xié)商并核簽的一種辦文程序，一般當(dāng)公文的內(nèi)容涉及本單位的多個部門或與其它單位有關(guān)時，需要進行會簽。586.文檔歸檔與保管軟件產(chǎn)品的文檔是軟件開發(fā)過程的真實記錄,是重要的信息資源，因此必須實行集中統(tǒng)一管理，使之完善、安全并能有效地利用。59(1)文檔歸檔歸檔的文檔應(yīng)包括整個軟件生存期內(nèi)所形成的全部文檔。文檔歸檔應(yīng)滿足以下條件：歸檔的文檔應(yīng)是經(jīng)過鑒定或評審的文檔應(yīng)簽署完整、成套、格式統(tǒng)一、字跡工整印制本、打印本以及各種報告應(yīng)裝訂成冊，并按規(guī)定進行編號，簽署軟件文檔應(yīng)在開發(fā)過程每個階段結(jié)束后及時歸檔60(2)文檔保管對一個單位來說，軟件文檔是極其重要的財富。應(yīng)在不同的地點建立設(shè)施來保存重要文檔的副本。這種非現(xiàn)場的保存應(yīng)儲藏所有開發(fā)文檔和產(chǎn)品文檔的后備副本。如果文檔是聯(lián)機開發(fā)的，則應(yīng)把它存儲到磁帶或磁盤上，以便能夠迅速地將這些文檔轉(zhuǎn)換成可用的形式。在人為事故或自然災(zāi)害情況下，可以使用備用的磁帶、磁盤、軟盤、清單、系統(tǒng)圖等重新構(gòu)造系統(tǒng)。文檔保管包括登記、保存、借閱和修改等四項工作文檔保管應(yīng)按國家和上級主管部門的要求，以及各單位的規(guī)章制度規(guī)定執(zhí)行。617.文檔維護軟件產(chǎn)品在投入運行后，往往還會有程序錯誤、文檔錯誤以及適應(yīng)新的環(huán)境和需求而要求增加或修改軟件及其相關(guān)文檔等情況。因此，必須對軟件產(chǎn)品及其文檔進行維護。62文檔維護步驟軟件產(chǎn)品完成后，確定軟件維護人員在軟件的運行過程中，由軟件維護人員負責(zé)收集、記錄從用戶或其他途徑反饋回來的軟件質(zhì)量信息在分析整理后，填寫“軟件問題報告”由軟件維護人員或項目課題組人員根據(jù)“軟件問題報告”中提出的要求，填寫“軟件修改申請報告”根據(jù)批準(zhǔn)后的“軟件修改申請報告”，由該項目的課題組人員或軟件維護人員對程序進行修改、測試63文檔維護步驟(續(xù))測試通過后，由程序修改人員填寫“軟件修改報告”并修改相應(yīng)的文檔和媒體將“軟件修改報告”和修改后的文檔送審核、會簽、標(biāo)準(zhǔn)化、批準(zhǔn)等有關(guān)負責(zé)人審閱、簽署將修改后的文檔、媒體和“軟件修改報告”送檔案管理部門存檔軟件維護人員匯總并整理修改情況，在此基礎(chǔ)上編寫“軟件維護通報”64主要內(nèi)容軟件文檔的作用管理者的作用制訂文檔編制策略制訂文檔編制標(biāo)準(zhǔn)和指南文檔編制計劃制訂文檔規(guī)程所需資源65所需資源為了編制高質(zhì)量文檔，必須得到必要的資源所需的資源包括：人員設(shè)備資金66(1)人員技術(shù)工作和技術(shù)管理主要取決于人。沒有任何指南、標(biāo)準(zhǔn)或方法(學(xué))能夠代替技術(shù)素質(zhì)高的人。技術(shù)寫作和文檔技術(shù)方面的某些培訓(xùn)是必要的，也是有用的。但是，放在首位的仍然是任用既勝任計算機程序開發(fā)、又勝任文檔工作的人員。67(2)設(shè)備某些自動的軟件工具已成功地應(yīng)用于開發(fā)文檔的編制工作。計算機程序能夠提供圖表、索引、數(shù)據(jù)元素表以及子程序和其他程序成分之間的交叉引用。這些可避免令人乏味地重復(fù)錄入草案材料，并且容許自動地重新打印更新后的文檔。用于檢查文檔的一致性及在需求、設(shè)計文檔和計算機代碼之間提供相關(guān)性的計算機技術(shù)也已經(jīng)開發(fā)成功。如果自動輔助工具的成本和附加資源相對于整個項目資源來說是合理的，則應(yīng)加以使