計(jì)算機(jī)文檔管理標(biāo)準(zhǔn)規(guī)范
軟件文檔管理指南
范圍
本標(biāo)準(zhǔn)為那些對(duì)軟件或基于軟件的產(chǎn)品的開(kāi)發(fā)負(fù)有職責(zé)的管理者提供軟件文檔的管理指南。本標(biāo)準(zhǔn)的目的在于協(xié)助管理者在他們的機(jī)構(gòu)中產(chǎn)生有效的文檔。
本標(biāo)準(zhǔn)涉及策略、標(biāo)準(zhǔn)、規(guī)程、資源和計(jì)劃,管理者必須關(guān)注這些內(nèi)容,以便有效地管理軟件文檔。
本標(biāo)準(zhǔn)期望應(yīng)用于各種類型的軟件,從簡(jiǎn)單的程序到復(fù)雜的軟件系統(tǒng)。并期望覆蓋各種類型的軟件文檔,作用于軟件生存期的各個(gè)階段。
不論項(xiàng)目的大小,軟件文檔管理的原則是一致的。對(duì)于小項(xiàng)目,可以不采用本標(biāo)準(zhǔn)中規(guī)定的有關(guān)細(xì)節(jié)。管理者可剪裁這些內(nèi)容以滿足他們的特殊需要。
本標(biāo)準(zhǔn)是針對(duì)文檔編制管理而提出的,不涉及軟件文檔的內(nèi)容和編排。
引用標(biāo)準(zhǔn)
下列標(biāo)準(zhǔn)所包含的條文本文章原創(chuàng)網(wǎng)站為網(wǎng),通過(guò)在本標(biāo)準(zhǔn)中引用而構(gòu)成為本標(biāo)準(zhǔn)的條文。本標(biāo)準(zhǔn)出版時(shí),所示版本均為有效,所有標(biāo)準(zhǔn)都會(huì)被修訂,使用本標(biāo)準(zhǔn)的各方應(yīng)探討使用下列標(biāo)準(zhǔn)最新版本的可能性。
計(jì)算機(jī)軟件開(kāi)發(fā)規(guī)范
計(jì)算機(jī)軟件產(chǎn)品開(kāi)發(fā)文件編制指南
軟件工程
……(新文秘網(wǎng)http://m.jey722.cn省略736字,正式會(huì)員可完整閱讀)……
作或增強(qiáng)某些功能。
這些人員需要的互相聯(lián)系是通過(guò)文檔資料的復(fù)制、分發(fā)和引用而實(shí)現(xiàn)的,因而,任務(wù)之間的聯(lián)系是文檔的一個(gè)重要功能。大多數(shù)系統(tǒng)開(kāi)發(fā)方法為任務(wù)的聯(lián)系規(guī)定了一些正式文檔。分析員向設(shè)計(jì)員提供正式需求規(guī)格說(shuō)明,設(shè)計(jì)員向程序員提供正式設(shè)計(jì)規(guī)格說(shuō)明,等等。
質(zhì)量保證
那些負(fù)責(zé)軟件質(zhì)量保證和評(píng)估系統(tǒng)性能的人員需要程序規(guī)格說(shuō)明、測(cè)試和評(píng)估計(jì)劃、測(cè)試該系統(tǒng)用的各種質(zhì)量標(biāo)準(zhǔn)以及關(guān)于期望系統(tǒng)完成什么功能和系統(tǒng)怎樣實(shí)現(xiàn)這些功能的清晰說(shuō)明;必須制訂測(cè)試計(jì)劃和測(cè)試規(guī)程,并報(bào)告測(cè)試結(jié)果;他們還必須說(shuō)明和評(píng)估完全、控制、計(jì)算、檢驗(yàn)例行程序及其他控制技術(shù)。這些文檔的提供可滿足質(zhì)量保證人員和審查人員上述工作的需要。
培訓(xùn)與參考
軟件文檔的另一個(gè)功能是使系統(tǒng)管理員、操作員、用戶、管理者和其他有關(guān)人員了解系統(tǒng)如何工作,以及為了達(dá)到他們的各自的目的,如何使用系統(tǒng)。
軟件維護(hù)支持
維護(hù)人員需要軟件系統(tǒng)的詳細(xì)說(shuō)明以幫助他們熟悉系統(tǒng),找出并修正錯(cuò)誤,改進(jìn)系統(tǒng)以適應(yīng)用戶需求的變化或適應(yīng)系統(tǒng)環(huán)境的變化。
歷史檔案
軟件文檔可用作未來(lái)項(xiàng)目的一種資源。通常文檔記載系統(tǒng)的開(kāi)發(fā)歷史,可使有關(guān)系統(tǒng)結(jié)構(gòu)的基本思想為以后的項(xiàng)目利用。系統(tǒng)開(kāi)發(fā)人員通過(guò)審閱以前的系統(tǒng)以查明什么部分已試驗(yàn)過(guò)了,什么部分運(yùn)行得很好,什么部分因某種原因難以運(yùn)行而被排除。良好的系統(tǒng)文檔有助于把程序移植和轉(zhuǎn)移到各種新的系統(tǒng)環(huán)境中。
管理者的作用
管理者嚴(yán)格要求軟件開(kāi)發(fā)人員和編制組完成文檔編制,并且在策略、標(biāo)準(zhǔn)、規(guī)程、資源分配和編制計(jì)劃方面給予支持。
管理者對(duì)文檔工作的責(zé)任。管理者要認(rèn)識(shí)到正式或非正式文檔都是重要的,還要認(rèn)識(shí)到文檔工作必須包括文檔計(jì)劃、編寫、修改、形成、分發(fā)和維護(hù)等各個(gè)方面。
管理者對(duì)文檔工作的支持。管理者應(yīng)為編寫文檔的人員提供指導(dǎo)和實(shí)際鼓勵(lì),并使各種資源有效地用于文檔開(kāi)發(fā)。
管理者的主要職責(zé):
。┙⒕幹啤⒌怯、出版系統(tǒng)文檔和軟件文檔的各種策略;
。┌盐臋n計(jì)劃作為整個(gè)開(kāi)發(fā)工作的一個(gè)組成部分;
。┙⒋_定文檔質(zhì)量、測(cè)試質(zhì)量和評(píng)審質(zhì)量的各種方法的規(guī)程;
。槲臋n的各個(gè)方面確定和準(zhǔn)備各種標(biāo)準(zhǔn)和指南;
。┓e極支持文檔工作以形成在開(kāi)發(fā)工作中自覺(jué)編制文檔的團(tuán)隊(duì)風(fēng)氣;
。┎粩鄼z查已建立起來(lái)的過(guò)程,以保證符合策略和各種規(guī)程并遵守有關(guān)標(biāo)準(zhǔn)和指南。
通常,項(xiàng)目管理者在項(xiàng)目開(kāi)發(fā)前應(yīng)決定如下事項(xiàng):
要求哪些類型的文檔;
提供多少種文檔;
文檔包含的內(nèi)容;
達(dá)到何種級(jí)別的質(zhì)量水平;
何時(shí)產(chǎn)生何種文檔;
如何保存、維護(hù)文檔以及如何進(jìn)行通信。
如果一個(gè)軟件合同是有效的,應(yīng)要求文檔滿足所接受的標(biāo)準(zhǔn),并規(guī)定所提供的文檔類型、每種文檔的質(zhì)量水平以及評(píng)審和通過(guò)的規(guī)程。
制訂文檔編制策略
文檔策略是由上級(jí)(資深)管理者新任務(wù)并支持的,對(duì)下級(jí)開(kāi)發(fā)單位或開(kāi)發(fā)人員提供指導(dǎo)。策略規(guī)定主要的方向不是做什么或如何做的詳細(xì)說(shuō)明。
一般說(shuō)來(lái),文檔編制策略陳述要明確,并通告到每個(gè)人且理解它,進(jìn)而使策略被他們貫徹實(shí)施。
支持有效文檔策略的基本條件:
文檔需要覆蓋整個(gè)軟件生存期
在項(xiàng)目早期幾個(gè)階段就要求有文檔,而且在貫穿軟件開(kāi)發(fā)過(guò)程中必須是可用的和可維護(hù)的。在開(kāi)發(fā)完成后,文檔應(yīng)滿足軟件的使用、維護(hù)、增強(qiáng)、轉(zhuǎn)換或傳輸。
文檔應(yīng)是可管理的
指導(dǎo)和控制文檔的獲得維護(hù),管理者和發(fā)行專家應(yīng)準(zhǔn)備文檔產(chǎn)品、進(jìn)度、可靠性、資源,質(zhì)量保證和評(píng)審規(guī)程的詳細(xì)計(jì)劃大綱。
文檔應(yīng)適合于它的讀者
讀者可能是管理者、分析員、無(wú)計(jì)算機(jī)經(jīng)驗(yàn)的專業(yè)人員、維護(hù)人員、文書人員等。根據(jù)任務(wù)的執(zhí)行,他們要求不同的材料表示和不同的詳細(xì)程度。針對(duì)不同的讀者,發(fā)行專家應(yīng)負(fù)責(zé)設(shè)計(jì)不同類型的文檔。
……(未完,全文共5887字,當(dāng)前僅顯示2067字,請(qǐng)閱讀下面提示信息。
收藏《計(jì)算機(jī)文檔管理標(biāo)準(zhǔn)規(guī)范》)