軟件文檔管理系統(tǒng)指南設(shè)計(jì)

《軟件文檔管理系統(tǒng)指南設(shè)計(jì)》由會(huì)員上傳分享，免費(fèi)在線閱讀，更多相關(guān)內(nèi)容在工程資料-天天文庫(kù)。

1、實(shí)用標(biāo)準(zhǔn)文案軟件文檔管理指南1范圍本標(biāo)準(zhǔn)為那些對(duì)軟件或基于軟件的產(chǎn)品的開發(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ì)文檔編制管理而提出的，不涉及軟件文檔

2、的內(nèi)容和編排。2引用標(biāo)準(zhǔn)下列標(biāo)準(zhǔn)所包含的條文，通過在本標(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)最新版本的可能性。GB8566-88計(jì)算機(jī)軟件開發(fā)規(guī)范GB8567-88計(jì)算機(jī)軟件產(chǎn)品開發(fā)文件編制指南GB/T11457-1995軟件工程術(shù)語3定義本標(biāo)準(zhǔn)采用下列定義，其他定義見GB/T11457。3.1文檔document一種數(shù)據(jù)媒體和其上所記錄的數(shù)據(jù)。它具有永久性并可以由人或機(jī)器閱讀。通常僅用于描述人工可讀的內(nèi)容。例如，技術(shù)文件、設(shè)計(jì)文件、版本說明文件。3.2文檔（集）；文檔編制

3、documentation一個(gè)或多個(gè)相關(guān)文檔的集合。精彩文檔實(shí)用標(biāo)準(zhǔn)文案3.3文檔計(jì)劃documentationplan一個(gè)描述文檔編制工作方法的管理用文檔。該計(jì)劃主要描述要編制什么類型的文檔，這些文檔的內(nèi)容是什么，何時(shí)編寫，由誰編寫，如何編寫，以及什么是影響期望結(jié)果的可用資源和外界因素。3.4文檔等級(jí)levelofdocumentation對(duì)所需文檔的一個(gè)說明，它指出文檔的范圍、內(nèi)容、格式及質(zhì)量，可以根據(jù)項(xiàng)目、費(fèi)用、預(yù)期用途、作用范圍或其他因素選擇文檔等級(jí)。3.5軟件產(chǎn)品softwareproduct軟件開發(fā)過程的結(jié)果，并推出供用戶使用的軟件實(shí)體。4

4、軟件文檔的作用a)管理依據(jù)；b)任務(wù)之間聯(lián)系的憑證；c)質(zhì)量保證；d)培訓(xùn)與參考；e)軟件維護(hù)支持；f)歷史檔案。4.1管理依據(jù)在軟件開過過程中，管理者必須了解開發(fā)進(jìn)度、存在的問題和預(yù)期目標(biāo)。每一階段計(jì)劃安排的定期報(bào)告提供了項(xiàng)目的可見性。定期報(bào)告還提醒各級(jí)管理者注意該部門對(duì)項(xiàng)目承擔(dān)的責(zé)任以及該部門效率的重要性。開發(fā)文檔規(guī)定若干個(gè)檢查點(diǎn)和進(jìn)度表，使管理者可以評(píng)定項(xiàng)目的進(jìn)度，如果開發(fā)文檔有遺漏，不完善，或內(nèi)容陳舊，則管理者將失去跟蹤和控制項(xiàng)目的重要依據(jù)。4.2任務(wù)之間聯(lián)系的憑證大多數(shù)軟件開發(fā)項(xiàng)目通常被劃分成若干個(gè)任務(wù)，并由不同的小組去完成。學(xué)科方面的專家建

5、立項(xiàng)目，分析員闡述系統(tǒng)需求，設(shè)計(jì)員為程序員制定總體設(shè)計(jì)，程序員編制詳細(xì)的程序代碼，質(zhì)量保證專家和審查員評(píng)價(jià)整個(gè)系統(tǒng)性能和功能的完整性，負(fù)責(zé)維護(hù)的程序員改進(jìn)各種操作或增強(qiáng)某些功能。精彩文檔實(shí)用標(biāo)準(zhǔn)文案這些人員需要的互相聯(lián)系是通過文檔資料的復(fù)制、分發(fā)和引用而實(shí)現(xiàn)的，因而，任務(wù)之間的聯(lián)系是文檔的一個(gè)重要功能。大多數(shù)系統(tǒng)開發(fā)方法為任務(wù)的聯(lián)系規(guī)定了一些正式文檔。分析員向設(shè)計(jì)員提供正式需求規(guī)格說明，設(shè)計(jì)員向程序員提供正式設(shè)計(jì)規(guī)格說明，等等。4.3質(zhì)量保證那些負(fù)責(zé)軟件質(zhì)量保證和評(píng)估系統(tǒng)性能的人員需要程序規(guī)格說明、測(cè)試和評(píng)估計(jì)劃、測(cè)試該系統(tǒng)用的各種質(zhì)量標(biāo)準(zhǔn)以及關(guān)于期望

6、系統(tǒng)完成什么功能和系統(tǒng)怎樣實(shí)現(xiàn)這些功能的清晰說明；必須制訂測(cè)試計(jì)劃和測(cè)試規(guī)程，并報(bào)告測(cè)試結(jié)果；他們還必須說明和評(píng)估完全、控制、計(jì)算、檢驗(yàn)例行程序及其他控制技術(shù)。這些文檔的提供可滿足質(zhì)量保證人員和審查人員上述工作的需要。4.4培訓(xùn)與參考軟件文檔的另一個(gè)功能是使系統(tǒng)管理員、操作員、用戶、管理者和其他有關(guān)人員了解系統(tǒng)如何工作，以及為了達(dá)到他們的各自的目的，如何使用系統(tǒng)。4.5軟件維護(hù)支持維護(hù)人員需要軟件系統(tǒng)的詳細(xì)說明以幫助他們熟悉系統(tǒng)，找出并修正錯(cuò)誤，改進(jìn)系統(tǒng)以適應(yīng)用戶需求的變化或適應(yīng)系統(tǒng)環(huán)境的變化。4.6歷史檔案軟件文檔可用作未來項(xiàng)目的一種資源。通常文檔記

7、載系統(tǒng)的開發(fā)歷史，可使有關(guān)系統(tǒng)結(jié)構(gòu)的基本思想為以后的項(xiàng)目利用。系統(tǒng)開發(fā)人員通過審閱以前的系統(tǒng)以查明什么部分已試驗(yàn)過了，什么部分運(yùn)行得很好，什么部分因某種原因難以運(yùn)行而被排除。良好的系統(tǒng)文檔有助于把程序移植和轉(zhuǎn)移到各種新的系統(tǒng)環(huán)境中。5管理者的作用管理者嚴(yán)格要求軟件開發(fā)人員和編制組完成文檔編制，并且在策略、標(biāo)準(zhǔn)、規(guī)程、資源分配和編制計(jì)劃方面給予支持。a)管理者對(duì)文檔工作的責(zé)任。管理者要認(rèn)識(shí)到正式或非正式文檔都是重要的，還要認(rèn)識(shí)到文檔工作必須包括文檔計(jì)劃、編寫、修改、形成、分發(fā)和維護(hù)等各個(gè)方面。b)管理者對(duì)文檔工作的支持。管理者應(yīng)為編寫文檔的人員提供指導(dǎo)和

8、實(shí)際鼓勵(lì)，并使各種資源有效地用于文檔開發(fā)。c)管理者的主要職責(zé)：1）建立編制、登記、出版系統(tǒng)文