軟件文檔管理指南ppt課件-文庫吧資料
2025-01-16 05:03本頁面
【正文】 檔編號 ? 文檔評審 ? 文檔簽署 ? 文檔歸檔與保管 ? 文檔維護(hù) 47 1. 文檔計(jì)劃制定 ? 項(xiàng)目一旦確定，就應(yīng)制定項(xiàng)目開發(fā)計(jì)劃 (包括文檔計(jì)劃 )，文檔計(jì)劃的制定遵照前述規(guī)定 48 2. 文檔編寫 ? 文檔的編寫是件非常細(xì)致的工作，從最初提出文檔編寫提綱開始，經(jīng)過逐步充實(shí)、完善，并經(jīng)反復(fù)檢查和修改，直至正式交付使用為止。 44 主要內(nèi)容 ? 軟件文檔的作用 ? 管理者的作用 ? 制訂文檔編制策略 ? 制訂文檔編制標(biāo)準(zhǔn)和指南 ? 文檔編制計(jì)劃 ? 制訂文檔規(guī)程 ? 所需資源 45 制訂文檔規(guī)程 ? 文檔編制規(guī)程應(yīng)符合前述文檔策略，并適用于整個(gè)軟件產(chǎn)品生存期內(nèi)文檔的編制和使用 ? 這些規(guī)程提出關(guān)于文檔的計(jì)劃、編制、評審、制作和分發(fā)的邏輯順序。 43 文檔計(jì)劃主要內(nèi)容 ? 此外，文檔計(jì)劃規(guī)定每個(gè)文檔要達(dá)到的質(zhì)量等級，以及為了達(dá)到期望的結(jié)果必須考慮哪些外部因素。如同任何別的計(jì)劃一樣，文檔計(jì)劃指出未來的各項(xiàng)活動，當(dāng)需要修改時(shí)必須加以修改。應(yīng)該編寫文檔計(jì)劃并把它分發(fā)給全體開發(fā)組成員，作為文檔重要性的具體依據(jù)和管理部門文檔工作責(zé)任的備忘錄 ? 對于小的、非正式的項(xiàng)目，文檔計(jì)劃可能只有一頁紙； ? 對于較大的項(xiàng)目，文檔計(jì)劃可能是一個(gè)綜合性的正式文檔，這樣的文檔計(jì)劃應(yīng)遵循各項(xiàng)嚴(yán)格的標(biāo)準(zhǔn)及正規(guī)的評審和批準(zhǔn)過程。 ? 要達(dá)到這四個(gè)質(zhì)量等級，需要的投入和資源逐級增加，質(zhì)量保證機(jī)構(gòu)必須處于適當(dāng)?shù)男姓匚灰员ＷC達(dá)到期望的質(zhì)量等級。 ? 關(guān)鍵性程序或具有重復(fù)管理應(yīng)用性質(zhì) (如工資計(jì)算 )的程序需 4級文檔 ? 應(yīng)遵守 GB 8567的有關(guān)規(guī)定 38 文檔質(zhì)量 ? 質(zhì)量方面需要考慮的問題即要包含文檔的結(jié)構(gòu)，也要包含文檔的內(nèi)容。 36 3級文檔 ? 工作文檔 ? 適于由同單位若干人聯(lián)合開發(fā)的程序，或可被其他單位使用的程序。 ? 該文檔應(yīng)包含程序清單、開發(fā)記錄、測試數(shù)據(jù)和程序簡介 35 2級文檔 ? 內(nèi)部文檔 ? 可用于在精心研究后被認(rèn)為似乎沒有與其他用戶共享資源的專用程序。文檔的質(zhì)量可以按文檔的形式和列出的要求劃分為四級。 ? 質(zhì)量要求的確定取決于可得到的資源、項(xiàng)目的大小和風(fēng)險(xiǎn)，可以對該產(chǎn)品的每個(gè)文檔的格式及詳細(xì)程度作出明確的規(guī)定。 27 基本的開發(fā)文檔 ? 可行性研究和項(xiàng)目任務(wù)書 ? 需求規(guī)格說明 ? 功能規(guī)格說明 ? 設(shè)計(jì)規(guī)格說明，包括程序和數(shù)據(jù)規(guī)格說明 ? 開發(fā)計(jì)劃 ? 軟件集成和測試計(jì)劃 ? 質(zhì)量保證計(jì)劃、標(biāo)準(zhǔn)、進(jìn)度 ? 安全和測試信息 28 (2) 產(chǎn)品文檔 ? 產(chǎn)品文檔規(guī)定關(guān)于軟件產(chǎn)品的使用、維護(hù)、增強(qiáng)、轉(zhuǎn)換和傳輸?shù)男畔? ? 產(chǎn)品的文檔起到如下三種作用 ?為使用運(yùn)行軟件產(chǎn)品的任何人規(guī)定培訓(xùn)和參考信息 ?使得那些未參加開發(fā)本軟件的程序員維護(hù)它 ?促進(jìn)軟件產(chǎn)品的市場流通或提高可接受性 ? 產(chǎn)品文檔用于用戶、運(yùn)行者和軟件維護(hù)人員 29 產(chǎn)品文檔內(nèi)容 ? 用于管理者的指南和資料 ?它們 是 用來監(jiān)督軟件的使用的 ? 宣傳資料 ?用于通告軟件產(chǎn)品的可用性并詳細(xì)說明它的功能、運(yùn)行環(huán)境等 ? 一般信息 ?用來對任何有興趣的人描述軟件產(chǎn)品 30 基本的產(chǎn)品文檔 ? 培訓(xùn)手冊 ? 參考手冊和用戶指南 ? 軟件支持手冊 ? 產(chǎn)品手冊和信息廣告 31 (3) 管理文檔 ? 這種文檔建立在項(xiàng)目管理信息的基礎(chǔ)上 ?開發(fā)過程每個(gè)階段的進(jìn)度和進(jìn)度變更的記錄 ?軟件變更情況的記錄 ?相對于開發(fā)的判定記錄 ?職責(zé)定義 ? 從管理的角度規(guī)定涉及軟件生存的信息 32 相關(guān)知識 ? 軟件文檔分類 ? 軟件文檔與使用者的關(guān)系 ? 軟件生存周期各階段與各種文檔編制的關(guān)系 ? 文檔所回答的問題 33 3. 文檔的質(zhì)量等級 ? 僅僅依據(jù)規(guī)章、傳統(tǒng)的做法或合同的要求去制作文檔是不夠的。通過規(guī)定軟件、主題事項(xiàng)、文檔編制、質(zhì)量保證人員以及包含在開發(fā)過程中任何其他事項(xiàng)的角色來定義做什么，如何做和何時(shí)做 ? 用作檢驗(yàn)點(diǎn)而允許管理者評定開發(fā)進(jìn)度。 24 2. 規(guī)定文檔類型和內(nèi)容 ? 軟件文檔歸入如下三種類別： ?開發(fā)文檔 —— 描述開發(fā)過程本身； ?產(chǎn)品文檔 —— 描述開發(fā)過程的產(chǎn)物； ?管理文檔 —— 記錄項(xiàng)目管理的信息。管理者將會發(fā)現(xiàn)所進(jìn)行的階段和相應(yīng)任務(wù)的定義有助于監(jiān)控軟件項(xiàng)目的進(jìn)展。從軟件文檔的觀點(diǎn)來看，采用哪種模型都無關(guān)緊要，只要階段和相應(yīng)文檔是清晰定義的、已計(jì)劃的，并且對于任何具體軟件項(xiàng)目是能遵循的。 ? 盡可能地采用現(xiàn)行的國家和國際標(biāo)準(zhǔn)，若現(xiàn)行的標(biāo)準(zhǔn)不適用，機(jī)構(gòu)應(yīng)制訂自己的標(biāo)準(zhǔn)。因此盡可能地使用工具是經(jīng)濟(jì)的、可行的。 20 支持有效文檔策略的基本條件 ? 文檔標(biāo)準(zhǔn)應(yīng)被標(biāo)識和使用 ?應(yīng)盡可能地采納現(xiàn)行的標(biāo)準(zhǔn)，若沒有合適的現(xiàn)行標(biāo)準(zhǔn)，必要時(shí)應(yīng)
公司管理相關(guān)推薦
鄂ICP備17016276號-1