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

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

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

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

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

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

中華人民共和國國家標準GB/T16680-1996軟件文檔管理指南neqISO/IECTR9294：1990Guidelinesforthemanagementofsoftwaredocumentation1范園本標準為那些對軟件或基于軟件的產(chǎn)品的開發(fā)負有職責的管理者提供軟件文檔的管理指南。本標準的目的在于協(xié)助管理者在他們的機構中產(chǎn)生有效的文檔。本標準涉及策略、標準、規(guī)程、資源和計劃，管理者必須關注這些內(nèi)容，以便有效地管理軟件文檔。本標準期望應用于各種類型的軟件,從簡單的程序到復雜的軟件系統(tǒng)。并期望復蓋各種類型的軟件文檔，作用于軟件生存期的各個階段。不論項目的大小，軟件文檔管理的原則是一致的。對于小項目，可以不采用本標準中規(guī)定的有關細節(jié)。管理者可剪裁這些內(nèi)容以滿足他們的特殊需要。本標準是針對文檔編制管理而提出的，不涉及軟件文檔的內(nèi)容和編排.2引用標準下列標準所包含的條文，通過在本標準中引用而構成為本標準的條文。本標準出版時，所示版本均為有效，所有標準都會被修訂，使用本標準的各方應探討使用下列標準最新版本的可能性，GB8566-88計算機軟件開發(fā)規(guī)范GB8567—88計算機軟件產(chǎn)品開發(fā)文件編制指南GB/T11457-1995軟件工程術語3定義本標準采用下列定義，其他定義見GB/T11457。3.1文檔document一種數(shù)據(jù)媒體和其上所記錄的數(shù)據(jù)。它具有永久性并可以由人或機器閥讀。通常僅用于描述人工可讀的內(nèi)容。例如，技術文件、設計文件、版本說明文件。3.2文檔(集);文檔編制documentation一個或多個相關文檔的集合。3.3文檔計劃documentationplan-個描述文檔編制工作方法的管理用文檔。該計劃主要描述要編制什么類型的文檔，這些文檔的內(nèi)容是什么，何時編寫，由誰編寫，如何編寫,以及什么是影響期望結果的可用資源和外界因素。3.4文檔等級levelofdocumentation