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