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