【正文】 54 文檔評審 ? 對一些大項目，正規(guī)評審?fù)ǔＴ陂_發(fā)方法學(xué)指導(dǎo)下進(jìn)行。 44 主要內(nèi)容 ? 軟件文檔的作用 ? 管理者的作用 ? 制訂文檔編制策略 ? 制訂文檔編制標(biāo)準(zhǔn)和指南 ? 文檔編制計劃 ? 制訂文檔規(guī)程 ? 所需資源 45 制訂文檔規(guī)程 ? 文檔編制規(guī)程應(yīng)符合前述文檔策略，并適用于整個軟件產(chǎn)品生存期內(nèi)文檔的編制和使用 ? 這些規(guī)程提出關(guān)于文檔的計劃、編制、評審、制作和分發(fā)的邏輯順序。 ? 要達(dá)到這四個質(zhì)量等級，需要的投入和資源逐級增加，質(zhì)量保證機構(gòu)必須處于適當(dāng)?shù)男姓匚灰员ＷC達(dá)到期望的質(zhì)量等級。文檔的質(zhì)量可以按文檔的形式和列出的要求劃分為四級。 24 2. 規(guī)定文檔類型和內(nèi)容 ? 軟件文檔歸入如下三種類別： ?開發(fā)文檔 —— 描述開發(fā)過程本身； ?產(chǎn)品文檔 —— 描述開發(fā)過程的產(chǎn)物； ?管理文檔 —— 記錄項目管理的信息。因此盡可能地使用工具是經(jīng)濟的、可行的。在開發(fā)完成后，文檔應(yīng)滿足軟件的使用、維護、增強、轉(zhuǎn)換或傳輸。 8 主要內(nèi)容 ? 軟件文檔的作用 ? 管理者的作用 ? 制訂文檔編制策略 ? 制訂文檔編制標(biāo)準(zhǔn)和指南 ? 文檔編制計劃 ? 制訂文檔規(guī)程 ? 所需資源 9 軟件文檔的作用 ? 管理依據(jù) ? 質(zhì)量保證 ? 軟件維護支持 ? 任務(wù)之間聯(lián)系的憑證 ? 培訓(xùn)與參考 ? 歷史檔案 10 主要內(nèi)容 ? 軟件文檔的作用 ? 管理者的作用 ? 制訂文檔編制策略 ? 制訂文檔編制標(biāo)準(zhǔn)和指南 ? 文檔編制計劃 ? 制訂文檔規(guī)程 ? 所需資源 11 管理者的作用 ? 管理者嚴(yán)格要求軟件開發(fā)人員和編制組完成文檔編制，并且在策略、標(biāo)準(zhǔn)、規(guī)程、資源分配和編制計劃方面給予支持。它具有永久性并可以由人或機器閱讀。 ? 本標(biāo)準(zhǔn)涉及策略、標(biāo)準(zhǔn)、規(guī)程、資源和計劃，管理者必須關(guān)注這些內(nèi)容，以便有效地管理軟件文檔。 3 簡介 ? 不論項目的大小，軟件文檔管理的原則是一致的。 ? 文檔（集） / 文檔編制 documentation ?一個或多個相關(guān)文檔的集合。 14 管理者的主要職責(zé) ? 建立編制、登記、出版系統(tǒng)文檔和軟件文檔的各種策略 ? 把文檔計劃作為整個開發(fā)工作的一個組成部分 ? 建立確定文檔質(zhì)量、測試質(zhì)量和評審質(zhì)量各種方法的規(guī)程 ? 為文檔的各個方面確定和準(zhǔn)備各種標(biāo)準(zhǔn)和指南 ? 積極支持文檔工作以形成開發(fā)中自覺編制文檔的團隊風(fēng)氣 ? 不斷檢查已建立起來的過程，以保證符合策略和各種規(guī)程并遵守有關(guān)標(biāo)準(zhǔn)和指南 15 項目管理者在開發(fā)前應(yīng)決定的事項 ? 要求哪些類型的文檔 ? 提供多少種文檔 ? 文檔包含的內(nèi)容 ? 達(dá)到何種級別的質(zhì)量水平 ? 何時產(chǎn)生何種文檔 ? 如何保存、維護文檔以及如何進(jìn)行通信 ? 如果一個軟件合同是有效的，應(yīng)要求文檔滿足所接受的標(biāo)準(zhǔn)，并規(guī)定所提供的文檔類型、每種文檔的質(zhì)量水平以及評審和通過的規(guī)程。根據(jù)任務(wù)的執(zhí)行，他們要求不同的材料表示和不同的詳細(xì)程度。 23 1. 選擇軟件生存期模型 ? 現(xiàn)有的一些軟件生存期模型，對于不同階段有不同的詞匯。如果開發(fā)文檔丟失、不完整或過時，管理者將失去跟蹤和控制軟件項目的一個重要工具； ? 形成了維護人員所要求的基本的軟件支持文檔，而這些支持文檔可作為產(chǎn)品文檔的一部分； ? 記錄軟件開發(fā)的歷史。 ? 除 1級文檔提供的信息外， 2級文檔還包括程序清單內(nèi)足夠的注釋以幫助用戶安裝和使用程序。 41 文檔編制計劃 ? 編制計劃的工作應(yīng)及早開始，對計劃的評審應(yīng)貫穿項目的全過程。 49 文檔編寫注意要點 ? 文檔編寫時間應(yīng)與軟件開發(fā)同步，在軟件生存期的每一個階段都應(yīng)完成相應(yīng)的文檔編寫工作 ? 按文檔計劃規(guī)定的文檔數(shù)量和質(zhì)量要求編寫文檔 ? 按 GB 8567或本單位指定標(biāo)準(zhǔn)內(nèi)容格式編寫相應(yīng)文檔 ? 文檔用紙的格式由各單位按有關(guān)標(biāo)準(zhǔn)規(guī)定執(zhí)行 ? 每個文檔必須裝訂成冊，并加封面和目次 ? 歸檔用的文檔還應(yīng)有扉頁，用于各責(zé)任者的簽署 50 3. 文檔編號 ? 為便于管理，軟件文檔應(yīng)按編號法進(jìn)行編號 ? 編號方法有十進(jìn)分類法、隸屬法等等，各單位可根據(jù)本單位實際情況確定一種編號方法 ? 不論何種方法，編號應(yīng)具有唯一性。 ? 對所有描述開發(fā)工作和產(chǎn)品的文檔進(jìn)行評審是正規(guī)評審過程的組成部分。正規(guī)備忘錄提供一份有關(guān)所有會議的記錄。 61 6. 文檔歸檔與保管 ? 軟件產(chǎn)品的文檔是軟件開發(fā)過程的真實記錄 ,是重要的信息資源，因此必須實行集中統(tǒng)一管理，使之完善、安全并能有效地利用。 64 7. 文檔維護 ? 軟件產(chǎn)品在投入運行后，往往還會有程序錯誤、文檔錯誤以及適應(yīng)新的環(huán)境和需求而要求增加或修改軟件及其相關(guān)文檔等情況。這些可避免令人乏味地重復(fù)錄入草案材料，并且容許自動地重新打印更新