軟件文檔管理指南ppt課件(編輯修改稿)
2025-02-06 05:03 本頁面
【文章內容簡介】 劃期間就有明確的規(guī)定。文檔的質量可以按文檔的形式和列出的要求劃分為四級。 34 1級文檔 ? 最低限度文檔 ? 適合開發(fā)工作量低于一個人月的開發(fā)者自用程序。 ? 該文檔應包含程序清單、開發(fā)記錄、測試數(shù)據(jù)和程序簡介 35 2級文檔 ? 內部文檔 ? 可用于在精心研究后被認為似乎沒有與其他用戶共享資源的專用程序。 ? 除 1級文檔提供的信息外， 2級文檔還包括程序清單內足夠的注釋以幫助用戶安裝和使用程序。 36 3級文檔 ? 工作文檔 ? 適于由同單位若干人聯(lián)合開發(fā)的程序，或可被其他單位使用的程序。 37 4級文檔 ? 正式文檔 ? 適于要正式發(fā)行供普遍使用的軟件產品。 ? 關鍵性程序或具有重復管理應用性質 (如工資計算 )的程序需 4級文檔 ? 應遵守 GB 8567的有關規(guī)定 38 文檔質量 ? 質量方面需要考慮的問題即要包含文檔的結構，也要包含文檔的內容。 ?文檔內容可根據(jù)正確性、完整性和明確性來判斷 ?文檔結構由各個組成部分的順序和總體安排的簡單性來測定。 ? 要達到這四個質量等級，需要的投入和資源逐級增加，質量保證機構必須處于適當?shù)男姓匚灰员ＷC達到期望的質量等級。 39 主要內容 ? 軟件文檔的作用 ? 管理者的作用 ? 制訂文檔編制策略 ? 制訂文檔編制標準和指南 ? 文檔編制計劃 ? 制訂文檔規(guī)程 ? 所需資源 40 文檔編制計劃 ? 文檔計劃可以是整個項目計劃的一部分或是一個獨立的文檔。應該編寫文檔計劃并把它分發(fā)給全體開發(fā)組成員，作為文檔重要性的具體依據(jù)和管理部門文檔工作責任的備忘錄 ? 對于小的、非正式的項目，文檔計劃可能只有一頁紙； ? 對于較大的項目，文檔計劃可能是一個綜合性的正式文檔，這樣的文檔計劃應遵循各項嚴格的標準及正規(guī)的評審和批準過程。 41 文檔編制計劃 ? 編制計劃的工作應及早開始，對計劃的評審應貫穿項目的全過程。如同任何別的計劃一樣，文檔計劃指出未來的各項活動，當需要修改時必須加以修改。導致對計劃作適當修改的常規(guī)評審應作為該項目工作的一部分，所有與該計劃有關的人員都應得到文檔計劃 42 文檔計劃主要內容 ? 列出應編制文檔的目錄 ? 提示編制文檔應參考的標準 ? 指定文檔管理員 ? 提供編制文檔所需要的條件，落實文檔編寫人員、所需經費以及編制工具等 ? 明確保證文檔質量的方法，為確保文檔內容的正確性、合理性，應采取一定的措施，如評審、鑒定等 ? 繪制進度表，以圖表形式列出在軟件生存期各階段應產生的文檔、編制人員、編制日期、完成日期、評審日期等。 43 文檔計劃主要內容 ? 此外，文檔計劃規(guī)定每個文檔要達到的質量等級，以及為了達到期望的結果必須考慮哪些外部因素。 ? 文檔計劃還確定該計劃和文檔的分發(fā)，并且明確敘述與文檔工作的所有人員的職責。 44 主要內容 ? 軟件文檔的作用 ? 管理者的作用 ? 制訂文檔編制策略 ? 制訂文檔編制標準和指南 ? 文檔編制計劃 ? 制訂文檔規(guī)程 ? 所需資源 45 制訂文檔規(guī)程 ? 文檔編制規(guī)程應符合前述文檔策略，并適用于整個軟件產品生存期內文檔的編制和使用 ? 這些規(guī)程提出關于文檔的計劃、編制、評審、制作和分發(fā)的邏輯順序。 ? 這些規(guī)程內含審批、質量保證及若干控制點，概述修改步驟、存儲和維護要求以及更新方法。 46 制訂文檔規(guī)程 ? 文檔計劃制定 ? 文檔編寫 ? 文檔編號 ? 文檔評審 ? 文檔簽署 ? 文檔歸檔與保管 ? 文檔維護 47 1. 文檔計劃制定 ? 項目一旦確定，就應制定項目開發(fā)計劃 (包括文檔計劃 )，文檔計劃的制定遵照前述規(guī)定 48 2. 文檔編寫 ? 文檔的編寫是件非常細致的工作，從最初提出文檔編寫提綱開始，經過逐步充實、完善，并經反復檢查和修改，直至正式交付使用為止。 49 文檔編寫注意要點 ? 文檔編寫時間應與軟件開發(fā)同步，在軟件生存期的每一個階段都應完成相應的文檔編寫工作 ? 按文檔計劃規(guī)定的文檔數(shù)量和質量要求編寫文檔 ? 按 GB 8567或本單位指定標準內容格式編寫相應文檔 ? 文檔用紙的格式由各單位按有關標準規(guī)定執(zhí)行 ? 每個文檔必須裝訂成冊，并加封面和目次 ? 歸檔用的文檔還應有扉頁，用于各責任者的簽署 50 3. 文檔編號 ? 為便于管理，軟件文檔應按編號法進行編號 ? 編號方法有十進分類法、隸屬法等等，各單位可根據(jù)本單位實際情況確定一種編號方法 ? 不論何種方法，編號應具有唯一性。 51 十進分類法 ? 十進分類編號方法 。 這種方法就是將產品的設計文件按規(guī)定的技術特征 （ 功能 、 結構 、 材料 、 用途 、工藝特征 ） ， 分為 10級 ， 每級分為 10類 ， 每類分為10型
公司管理相關推薦
鄂ICP備17016276號-1