GB/T 16680-1996軟件文檔管理指南

中華人民共和國國家標(biāo)準(zhǔn)GB/T16680—1996neqISO/IECTR9294：1990軟件文檔管理指南Guidelinesforthemanagementofsoftwaredocumentation1996-12-18發(fā)布1997-07-01實施國家技術(shù)監(jiān)督局發(fā)布

GB/T16680-1996前言ISO/IEC前言引言范圍2引用標(biāo)準(zhǔn)定義34軟件文檔的作用5管理者的作用6制訂文檔編制策略7制訂文檔編制標(biāo)準(zhǔn)和指南文檔編制計劃制訂文檔規(guī)程10所需資源·….·…．··.··…·….·附錄A(提示的附錄)文檔策略檢查表附錄B(提示的附錄)文檔計劃檢查表附錄C(提示的附錄)文檔管理規(guī)程檢查表附錄D(提示的附錄)軟件文檔編制時間附錄E(提示的附錄）各評審點(diǎn)評審內(nèi)容附錄F(提示的附錄)軟件文檔簽署者

GB/T16680-1996前本標(biāo)準(zhǔn)非等效采用國際標(biāo)準(zhǔn)ISO/IECTR9294:1990《信息技術(shù)：軟件文檔管理指南》。本標(biāo)準(zhǔn)與ISO/IECTR9294的主要差別如下：個別章條作了調(diào)整；所引用的標(biāo)準(zhǔn)作了變更；C）定義部分增加了內(nèi)容；枝術(shù)要素充實了內(nèi)容，增加了一些實用措施。如：文檔編寫、簽署、審查、歸檔和修改等內(nèi)容；e）附錄部分也作了調(diào)整和擴(kuò)充，主要是增加了附錄D、附錄E和附錄F。本標(biāo)準(zhǔn)的附錄A到附錄F均是提示的附錄。本標(biāo)準(zhǔn)由中華人民共和國電子工業(yè)部提出。本標(biāo)準(zhǔn)由電子工業(yè)部標(biāo)準(zhǔn)化研究所歸口。本標(biāo)準(zhǔn)起草單位：電子工業(yè)部標(biāo)準(zhǔn)化研究所、華東計算技術(shù)研究所。本標(biāo)準(zhǔn)主要起草人：馮惠、王家增、鄭人杰。

GB/T16680-1996ISO/IEC前言ISO(國際標(biāo)準(zhǔn)化組織)和IEC(國際電工委員會)是世界性的標(biāo)準(zhǔn)化專門機(jī)構(gòu)。國家成員體(它們都是ISO或IC的成員國)通過國際組織建立的各個技術(shù)委員會參與制定針對特定技術(shù)范圍的國際標(biāo)準(zhǔn)。ISO和IEC的各技術(shù)委員會在共同感興趣的領(lǐng)域內(nèi)進(jìn)行合作。與ISO和IC有聯(lián)系的其他官方和非官方國際組織也可參與國際標(biāo)準(zhǔn)的制定工作對于信息技術(shù),ISO和IEC建立了一個聯(lián)合技術(shù)委員會,即ISO/IECJTCl.技術(shù)委員會的主要任務(wù)是制定國際標(biāo)準(zhǔn)，但在例外的情況下，技術(shù)委員會可以提出下列類型之一的技術(shù)報告：類型1:雖然一再努力，但仍不能獲得出版一項國際標(biāo)準(zhǔn)所需要的支持時；類型2:所討論的項目仍處于技術(shù)發(fā)展階段；類型3:技術(shù)委員會所收集到的數(shù)據(jù)不是來源于正式出版的國際標(biāo)準(zhǔn)(例如"目前工藝水平")時類型1和類型2技術(shù)報告在出版后3年內(nèi)應(yīng)提交復(fù)審,以決定是否將它們轉(zhuǎn)變成國際標(biāo)準(zhǔn)。類型3技術(shù)報告不是務(wù)必要進(jìn)行復(fù)審，除非它們提供的數(shù)據(jù)已被認(rèn)為不再有效或已經(jīng)沒有用。ISO/IECTR9294屬于類型3技術(shù)報告,它是由ISO/IECJTCl“信息技術(shù)”聯(lián)合技術(shù)委員會制定的

軟件生存期的所有階段都要求編制文檔。因此.文檔編制和維護(hù)是必需的并且從軟件的概念階段連續(xù)作用到它廢止。文檔編制開始于軟件項目的初始階段，并貫穿于軟件的設(shè)計、開發(fā)、測試、安裝、使用、修改和增強(qiáng)。僅當(dāng)軟件走到它的生命終點(diǎn)時才認(rèn)為文檔編制過程結(jié)束。文檔編制是任何軟件開發(fā)項目成功的基礎(chǔ),并且文檔的產(chǎn)生需要有時間、人工和資金的支撐。管理的職責(zé)是保證這些資源有效地利用重要文檔的標(biāo)識以使軟件產(chǎn)品成功開發(fā)并提高質(zhì)量。

中華人民共和國國家標(biāo)準(zhǔn)GB/T16680-1996軟件文檔管理指南neqISO/IECTR9294：1990Guidelinesforthemanagementofsoftwaredocumentation1范園本標(biāo)準(zhǔn)為那些對軟件或基于軟件的產(chǎn)品的開發(fā)負(fù)有職責(zé)的管理者提供軟件文檔的管理指南。本標(biāo)準(zhǔn)的目的在于協(xié)助管理者在他們的機(jī)構(gòu)中產(chǎn)生有效的文檔。本標(biāo)準(zhǔn)涉及策略、標(biāo)準(zhǔn)、規(guī)程、資源和計劃，管理者必須關(guān)注這些內(nèi)容，以便有效地管理軟件文檔。本標(biāo)準(zhǔn)期望應(yīng)用于各種類型的軟件,從簡單的程序到復(fù)雜的軟件系統(tǒng)。并期望復(fù)蓋各種類型的軟件文檔，作用于軟件生存期的各個階段。不論項目的大小，軟件文檔管理的原則是一致的。對于小項目，可以不采用本標(biāo)準(zhǔn)中規(guī)定的有關(guān)細(xì)節(jié)。管理者可剪裁這些內(nèi)容以滿足他們的特殊需要。本標(biāo)準(zhǔn)是針對文檔編制管理而提出的，不涉及軟件文檔的內(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)出版時，所示版本均為有效，所有標(biāo)準(zhǔn)都會被修訂，使用本標(biāo)準(zhǔn)的各方應(yīng)探討使用下列標(biāo)準(zhǔn)最新版本的可能性，GB8566-88計算機(jī)軟件開發(fā)規(guī)范GB8567—88計算機(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è)計文件、版本說明文件。3.2文檔(集);文檔編制documentation一個或多個相關(guān)文檔的集合。3.3文檔計劃documentationplan-個描述文檔編制工作方法的管理用文檔。該計劃主要描述要編制什么類型的文檔，這些文檔的內(nèi)容是什么，何時編寫，由誰編寫，如何編寫,以及什么是影響期望結(jié)果的可用資源和外界因素。3.4文檔等級levelofdocumentation