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