《軟件文檔管理指南》ppt課件-文庫吧
2024-12-26 05:03 本頁面
【正文】 保證和評(píng)審規(guī)程的詳細(xì)計(jì)劃大綱。 19 支持有效文檔策略的基本條件 ? 文檔應(yīng)適合于它的讀者 ?讀者可能是管理者、分析員、無計(jì)算機(jī)經(jīng)驗(yàn)的專業(yè)人員、維護(hù)人員、文書人員等。根據(jù)任務(wù)的執(zhí)行，他們要求不同的材料表示和不同的詳細(xì)程度。針對(duì)不同的讀者，發(fā)行專家應(yīng)負(fù)責(zé)設(shè)計(jì)不同類型的文檔。 ? 文檔效應(yīng)應(yīng)貫穿到軟件的整個(gè)開發(fā)過程中 ?在軟件開發(fā)的整個(gè)過程中，應(yīng)充分體現(xiàn)文檔的作用和限制，即文檔應(yīng)指導(dǎo)全部開發(fā)過程。 20 支持有效文檔策略的基本條件 ? 文檔標(biāo)準(zhǔn)應(yīng)被標(biāo)識(shí)和使用 ?應(yīng)盡可能地采納現(xiàn)行的標(biāo)準(zhǔn)，若沒有合適的現(xiàn)行標(biāo)準(zhǔn)，必要時(shí)應(yīng)研制適用的標(biāo)準(zhǔn)或指南。 ? 應(yīng)規(guī)定支持工具 ?工具有助于開發(fā)和維護(hù)軟件產(chǎn)品，包括文檔。因此盡可能地使用工具是經(jīng)濟(jì)的、可行的。 21 主要內(nèi)容 ? 軟件文檔的作用 ? 管理者的作用 ? 制訂文檔編制策略 ? 制訂文檔編制標(biāo)準(zhǔn)和指南 ? 文檔編制計(jì)劃 ? 制訂文檔規(guī)程 ? 所需資源 22 制訂文檔編制標(biāo)準(zhǔn)和指南 ? 在一個(gè)機(jī)構(gòu)內(nèi)部，應(yīng)采用一些標(biāo)準(zhǔn)和指南： ?軟件生存期模型 ?文檔類型和相互關(guān)系 ?文檔質(zhì)量 ? 這些標(biāo)準(zhǔn)和指南將決定如何實(shí)現(xiàn)文檔任務(wù)，將提供一些準(zhǔn)則以評(píng)價(jià)該機(jī)構(gòu)內(nèi)所產(chǎn)生的軟件文檔的完整性、可用性和適合性。 ? 盡可能地采用現(xiàn)行的國家和國際標(biāo)準(zhǔn)，若現(xiàn)行的標(biāo)準(zhǔn)不適用，機(jī)構(gòu)應(yīng)制訂自己的標(biāo)準(zhǔn)。 23 1. 選擇軟件生存期模型 ? 現(xiàn)有的一些軟件生存期模型，對(duì)于不同階段有不同的詞匯。從軟件文檔的觀點(diǎn)來看，采用哪種模型都無關(guān)緊要，只要階段和相應(yīng)文檔是清晰定義的、已計(jì)劃的，并且對(duì)于任何具體軟件項(xiàng)目是能遵循的。 ? 因此，管理者應(yīng)選擇一個(gè)軟件生存期模型并保證該模型在他們機(jī)構(gòu)內(nèi)是適用的。管理者將會(huì)發(fā)現(xiàn)所進(jìn)行的階段和相應(yīng)任務(wù)的定義有助于監(jiān)控軟件項(xiàng)目的進(jìn)展。相應(yīng)于特定階段生成的文檔可用作該階段的評(píng)審、通過和完成的檢驗(yàn)點(diǎn)，而這種檢驗(yàn)應(yīng)在下一階段開始前進(jìn)行。 24 2. 規(guī)定文檔類型和內(nèi)容 ? 軟件文檔歸入如下三種類別： ?開發(fā)文檔 —— 描述開發(fā)過程本身； ?產(chǎn)品文檔 —— 描述開發(fā)過程的產(chǎn)物； ?管理文檔 —— 記錄項(xiàng)目管理的信息。 25 (1) 開發(fā)文檔 ? 開發(fā)文檔 是描述軟件開發(fā)過程，包括軟件需求、軟件設(shè)計(jì)、軟件測(cè)試、保證軟件質(zhì)量的一類文檔，開發(fā)文檔也包括軟件的詳細(xì)技術(shù)描述 (程序邏輯、程序間相互關(guān)系、數(shù)據(jù)格式和存儲(chǔ)等 ) 26 開發(fā)文檔的作用 ? 是軟件開發(fā)過程所有階段間的通信工具，它記錄生成軟件需求、設(shè)計(jì)、編碼和測(cè)試的詳細(xì)規(guī)定和說明 ? 描述開發(fā)小組的職責(zé)。通過規(guī)定軟件、主題事項(xiàng)、文檔編制、質(zhì)量保證人員以及包含在開發(fā)過程中任何其他事項(xiàng)的角色來定義做什么，如何做和何時(shí)做 ? 用作檢驗(yàn)點(diǎn)而允許管理者評(píng)定開發(fā)進(jìn)度。如果開發(fā)文檔丟失、不完整或過時(shí)，管理者將失去跟蹤和控制軟件項(xiàng)目的一個(gè)重要工具； ? 形成了維護(hù)人員所要求的基本的軟件支持文檔，而這些支持文檔可作為產(chǎn)品文檔的一部分； ? 記錄軟件開發(fā)的歷史。 27 基本的開發(fā)文檔 ? 可行性研究和項(xiàng)目任務(wù)書 ? 需求規(guī)格說明 ? 功能規(guī)格說明 ? 設(shè)計(jì)規(guī)格說明，包括程序和數(shù)據(jù)規(guī)格說明 ? 開發(fā)計(jì)劃 ? 軟件集成和測(cè)試計(jì)劃 ? 質(zhì)量保證計(jì)劃、標(biāo)準(zhǔn)、進(jìn)度 ? 安全和測(cè)試信息 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ǎng)流通或提高可接受性 ? 產(chǎn)品文檔用于用戶、運(yùn)行者和軟件維護(hù)人員 29 產(chǎn)品文檔內(nèi)容 ? 用于管理者的指南和資料 ?它們 是 用來監(jiān)督軟件的使用的 ? 宣傳資料 ?用于通告軟件產(chǎn)品的可用性并詳細(xì)說明它的功能、運(yùn)行環(huán)境等 ? 一般信息 ?用來對(duì)任何有興趣的人描述軟件產(chǎn)品 30 基本的產(chǎn)品文檔 ? 培訓(xùn)手冊(cè) ? 參考手冊(cè)和用戶指南 ? 軟件支持手冊(cè) ? 產(chǎn)品手冊(cè)和信息廣告 31 (3) 管理文檔 ? 這種文檔建立在項(xiàng)目管理信息的基礎(chǔ)上 ?開發(fā)過程每個(gè)階段的進(jìn)度和進(jìn)度變更的記錄 ?軟件變更情況的記錄 ?相對(duì)于開發(fā)的判定記錄 ?職責(zé)定義 ? 從管理的角度規(guī)定涉及軟件生存的信息 32 相關(guān)知識(shí) ? 軟件文檔分類 ? 軟件文檔與使用者的關(guān)系 ? 軟件生存周期各階段與各種文檔編制的關(guān)系 ? 文檔所回答的問題 33 3. 文檔的質(zhì)量等級(jí) ? 僅僅依據(jù)規(guī)章、傳統(tǒng)的做法或合同的要求去制作文檔是不夠的。管理者還必須確定文檔的質(zhì)量要求以及如何達(dá)到和保證質(zhì)量要求。 ? 質(zhì)量要求的確定取決于可得到的資源、項(xiàng)目的大小和風(fēng)險(xiǎn)，可以對(duì)該產(chǎn)品的每個(gè)文檔的格式及詳細(xì)程度作出明確的規(guī)定。 ? 每個(gè)文檔的質(zhì)量必須在文檔計(jì)
公司管理相關(guān)推薦
鄂ICP備17016276號(hào)-1