軟件文檔管理指南ppt課件-wenkub
2023-01-25 05:03:35 本頁面
【正文】 開發(fā)文檔 ? 開發(fā)文檔 是描述軟件開發(fā)過程，包括軟件需求、軟件設(shè)計、軟件測試、保證軟件質(zhì)量的一類文檔，開發(fā)文檔也包括軟件的詳細技術(shù)描述 (程序邏輯、程序間相互關(guān)系、數(shù)據(jù)格式和存儲等 ) 26 開發(fā)文檔的作用 ? 是軟件開發(fā)過程所有階段間的通信工具，它記錄生成軟件需求、設(shè)計、編碼和測試的詳細規(guī)定和說明 ? 描述開發(fā)小組的職責(zé)。 ? 因此，管理者應(yīng)選擇一個軟件生存期模型并保證該模型在他們機構(gòu)內(nèi)是適用的。 21 主要內(nèi)容 ? 軟件文檔的作用 ? 管理者的作用 ? 制訂文檔編制策略 ? 制訂文檔編制標準和指南 ? 文檔編制計劃 ? 制訂文檔規(guī)程 ? 所需資源 22 制訂文檔編制標準和指南 ? 在一個機構(gòu)內(nèi)部，應(yīng)采用一些標準和指南： ?軟件生存期模型 ?文檔類型和相互關(guān)系 ?文檔質(zhì)量 ? 這些標準和指南將決定如何實現(xiàn)文檔任務(wù)，將提供一些準則以評價該機構(gòu)內(nèi)所產(chǎn)生的軟件文檔的完整性、可用性和適合性。 ? 文檔效應(yīng)應(yīng)貫穿到軟件的整個開發(fā)過程中 ?在軟件開發(fā)的整個過程中，應(yīng)充分體現(xiàn)文檔的作用和限制，即文檔應(yīng)指導(dǎo)全部開發(fā)過程。 ? 文檔應(yīng)是可管理的 ?指導(dǎo)和控制文檔的獲得和維護，管理者和發(fā)行專家應(yīng)準備文檔產(chǎn)品、進度、可靠性、資源，質(zhì)量保證和評審規(guī)程的詳細計劃大綱。 ? 策略規(guī)定主要的方向，不是做什么或如何做的詳細說明。 12 管理者對文檔工作的責(zé)任 ? 管理者要認識到正式或非正式文檔都是重要的，還要認識到文檔工作必須包括文檔計劃、編寫、修改、形成、分發(fā)和維護等各個方面。 ?該計劃主要描述要編制什么類型的文檔，這些文檔的內(nèi)容是什么，何時編寫，由誰編寫，如何編寫，以及什么是影響期望結(jié)果的可用資源和外界因素。通常僅用于描述人工可讀的內(nèi)容。管理者可剪裁這些內(nèi)容以滿足他們的特殊需要。 ? 本標準期望應(yīng)用于各種類型的軟件，從簡單的程序到復(fù)雜的軟件系統(tǒng)。1 軟件文檔管理指南 (GB/T1668096) 2 簡介 ? 本標準為那些對軟件或基于軟件產(chǎn)品的開發(fā)負有職責(zé)的管理者提供軟件文檔的管理指南。并期望覆蓋各種類型的軟件文檔，作用于軟件生存期的各個階段。 ? 本標準是針對文檔編制管理而提出的，不涉及軟件文檔的內(nèi)容和編排。例如，技術(shù)文件、設(shè)計文件、版本說明文件。 7 定義 ? 文檔等級 level of documentation ?對所需文檔的一個說明，它指出文檔的范圍、內(nèi)容、格式及質(zhì)量，可以根據(jù)項目、費用、預(yù)期用途、作用范圍或其他因素選擇文檔等級。 13 管理者對文檔工作的支持 ? 管理者應(yīng)為編寫文檔的人員提供指導(dǎo)和實際鼓勵，并使各種資源有效地用于文檔開發(fā)。 ? 一般說來，文檔編制策略陳述要明確，并通告到每個人且理解它，進而使策略被他們貫徹實施。 19 支持有效文檔策略的基本條件 ? 文檔應(yīng)適合于它的讀者 ?讀者可能是管理者、分析員、無計算機經(jīng)驗的專業(yè)人員、維護人員、文書人員等。 20 支持有效文檔策略的基本條件 ? 文檔標準應(yīng)被標識和使用 ?應(yīng)盡可能地采納現(xiàn)行的標準，若沒有合適的現(xiàn)行標準，必要時應(yīng)研制適用的標準或指南。 ? 盡可能地采用現(xiàn)行的國家和國際標準，若現(xiàn)行的標準不適用，機構(gòu)應(yīng)制訂自己的標準。管理者將會發(fā)現(xiàn)所進行的階段和相應(yīng)任務(wù)的定義有助于監(jiān)控軟件項目的進展。通過規(guī)定軟件、主題事項、文檔編制、質(zhì)量保證人員以及包含在開發(fā)過程中任何其他事項的角色來定義做什么，如何做和何時做 ? 用作檢驗點而允許管理者評定開發(fā)進度。 ? 質(zhì)量要求的確定取決于可得到的資源、項目的大小和風(fēng)險，可以對該產(chǎn)品的每個文檔的格式及詳細程度作出明確的規(guī)定。 ? 該文檔應(yīng)包含程序清單、開發(fā)記錄、測試數(shù)據(jù)和程序簡介 35 2級文檔 ? 內(nèi)部文檔 ? 可用于在精心研究后被認為似乎沒有與其他用戶共享資源的專用程序。 ? 關(guān)鍵性程序或具有重復(fù)管理應(yīng)用性質(zhì) (如工資計算 )的程序需 4級文檔 ? 應(yīng)遵守 GB 8567的有關(guān)規(guī)定 38 文檔質(zhì)量 ? 質(zhì)量方面需要考慮的問題即要包含文檔的結(jié)構(gòu)，也要包含文檔的內(nèi)容。應(yīng)該編寫文檔計劃并把它分發(fā)給全體開發(fā)組成員，作為文檔重要性的具體依據(jù)和管理部門文檔工作責(zé)任的備忘錄 ? 對于小的、非正式的項目，文檔計劃可能只有一頁紙； ? 對于較大的項目，文檔計劃可能是一個綜合性的正式文檔，這樣的文檔計劃應(yīng)遵循各項嚴格的標準及正規(guī)的評審和批準過程。 43 文檔計劃主要內(nèi)容 ? 此外，文檔計劃規(guī)定每個文檔要達到的質(zhì)量等級，以及為了達到期望的結(jié)果必須考慮哪些外部因素。 46 制訂文檔規(guī)程 ? 文檔計劃制定 ? 文檔編寫 ? 文檔編號 ? 文檔評審 ? 文檔簽署 ? 文檔歸檔與保管 ? 文檔維護 47 1. 文檔計劃制定 ? 項目一旦確定，就應(yīng)制定項目開發(fā)計劃 (包括文檔計劃 )，文檔計劃的制
公司管理相關(guān)推薦
鄂ICP備17016276號-1