
Systems and software engineering—Requirements for managers of user documentation
標(biāo)準(zhǔn)號:GB/T 16680-2015
本標(biāo)準(zhǔn)支持軟件用戶對文檔一致性、完備性、準(zhǔn)確性和可用性的要求。它為文檔管理者提供策略、策劃、執(zhí)行和控制。它指明貫穿整個軟件生存周期的用戶文檔管理過程。它也包括用戶文檔管理的關(guān)鍵過程,即文檔編制計劃和文檔管理計劃。本標(biāo)準(zhǔn)提供了軟件文檔編制和用于文檔編制的信息管理過程的概述。同時還描述了用于文檔編制的組合計劃和內(nèi)容管理。具體來說,它專注于以下內(nèi)容:———項目啟動時的管理要求,包括建立過程和規(guī)范,建立基礎(chǔ)設(shè)施,建立團(tuán)隊并列舉用戶文檔團(tuán)隊所需要的角色;———文檔管理控制所需的測量和估算;———對用戶文檔編制工作進(jìn)行管理控制;———支持過程的運用,例如變更管理,進(jìn)度和成本控制,資源管理,質(zhì)量管理和過程改進(jìn)。參考文獻(xiàn)中所列內(nèi)容對管理、準(zhǔn)備和測試用戶文檔的過程提供了指南。注1:過程中所涉及的文檔管理者和其他的相關(guān)標(biāo)準(zhǔn)有:ISO/IEC26514:2008《系統(tǒng)和軟件工程 對用戶文檔設(shè)計者和開發(fā)者的要求》(IEEE標(biāo)準(zhǔn)26514—2010,采用ISO/IEC26514:2008的IEEE標(biāo)準(zhǔn),系統(tǒng)和軟件工程 對用戶文檔設(shè)計者和開發(fā)者的要求),ISO/IEC26513:2009《系統(tǒng)與軟件工程 對用戶文檔測試者和評審者的要求》(IEEE標(biāo)準(zhǔn)26513:2010,采用ISO/IEC26513:2009的IEEE標(biāo)準(zhǔn),系統(tǒng)與軟件工程 對用戶文檔測試者和評審者的要求)和ISO/IEC/IEEE26512:2011《系統(tǒng)和軟件工程 對用戶文檔需方和供方的要求》。本標(biāo)準(zhǔn)適用于用戶文檔編制項目的管理者的使用,適用于擁有信息設(shè)計和文檔開發(fā)人員的組織。本標(biāo)準(zhǔn)也可供其他角色和對文檔編制過程感興趣的人員參考:———軟件開發(fā)過程的管理者;———購買供方文檔的用戶;———經(jīng)驗豐富的編寫用戶文檔內(nèi)容的人員;———創(chuàng)建電子版文檔工具的開發(fā)人員;———研究使文檔更加方便和易用的人因分析專家;———電子媒體方面的平面設(shè)計師;———共同設(shè)計文檔在屏幕上展現(xiàn)形式的用戶界面設(shè)計師和人體工程學(xué)專家。本標(biāo)準(zhǔn)也可用于管理以下類型的文檔,盡管它并沒有涵蓋所有的方面:———用于幫助用戶、培訓(xùn)和銷售的文檔和用于產(chǎn)品設(shè)計和開發(fā)的系統(tǒng)文檔,這些文檔是基于用戶文檔主題重用的;———非軟件產(chǎn)品文檔;———使用動畫、視頻和聲音的多媒體銷售演示;———正式培訓(xùn)課程中使用的基于計算機(jī)的培訓(xùn)[computer-basedtraining(CBT)]資源文件包和特定的課程教材;———描述系統(tǒng)軟件內(nèi)部運作的維護(hù)文檔。注2:ISO/IEC/IEEE15289:2011提供了關(guān)于生存周期過程中的信息項(文檔)更詳細(xì)的內(nèi)容。
本標(biāo)準(zhǔn)按照GB/T1.1—2009給出的規(guī)則起草。 本標(biāo)準(zhǔn)代替GB/T16680—1996《軟件文檔管理指南》。 本標(biāo)準(zhǔn)對GB/T16680—1996進(jìn)行修訂,與GB/T16680—1996相比,主要變化如下: ———名稱改為“系統(tǒng)與軟件工程 用戶文檔的管理者要求”; ———增加了第2章符合性; ———刪除了第4章軟件文檔的作用; ———刪除了第5章管理者的作用; ———增加了5.1軟件生存周期過程中的用戶文檔管理; ———增加了第6章文檔管理策劃; ———第6章制定文檔編制策略(見1996版)調(diào)整為5.3信息管理策略與方針; ———刪除了第7章制定文檔編制標(biāo)準(zhǔn)和指南; ———增加了第7章用戶文檔計劃; ———增加了第8章項目啟動; ———原標(biāo)準(zhǔn)第8章文檔編制計劃(見1996版)調(diào)整為6.2用戶文檔編寫計劃; ———刪除了第9章制定文檔規(guī)程; ———增加了第9章用戶文檔管理控制方法; ———增加了第10章管理控制在文檔中的應(yīng)用; ———10.1人員(見1996版)調(diào)整為8.3信息開發(fā)團(tuán)隊; ———10.2設(shè)備(見1996版)調(diào)整為8.2基礎(chǔ)設(shè)施。 本標(biāo)準(zhǔn)使用翻譯法等同采用ISO/IEC26511:2011《系統(tǒng)與軟件工程用戶文檔的管理者要求》。 本標(biāo)準(zhǔn)做了以下編輯性修改: ———為方便使用,將ISO/IEC12207:2008中的6.3.6和7.2.1節(jié)錄,以表B.1形式給出。 請注意本文件的某些內(nèi)容可能涉及專利。本文件的發(fā)布機(jī)構(gòu)不承擔(dān)識別這些專利的責(zé)任。 本標(biāo)準(zhǔn)由全國信息技術(shù)標(biāo)準(zhǔn)化技術(shù)委員會(SAC/TC28)提出并歸口。 本標(biāo)準(zhǔn)的起草單位:珠海南方軟件網(wǎng)絡(luò)評測中心、中國電子技術(shù)標(biāo)準(zhǔn)化研究院、北京師范大學(xué)珠海分校、國家網(wǎng)絡(luò)軟件產(chǎn)品質(zhì)量監(jiān)督檢驗中心(濟(jì)南)。 本標(biāo)準(zhǔn)的主要起草人:侯建華、梁勇、孫瑋、倪玉華、彭宇帆、梁建新、黃兆森、黃姍姍、相福民、張雪莉、何春江、楊靜、于文、張燕、張佳佳。 GB/T16680的歷次版本發(fā)布情況為: ———GB/T16680—1996。 |
前言 Ⅲ 引言 Ⅳ 1 范圍 1 2 符合性 2 2.1 符合性定義 2 2.2 符合性場景 2 3 規(guī)范性引用文件 2 4 術(shù)語和定義 2 5 生存周期過程中的用戶文檔管理 5 5.1 軟件生存周期中的用戶文檔管理 5 5.2 組合管理和內(nèi)容管理 6 5.3 信息管理策略與方針 6 6 文檔管理策劃 7 6.1 文檔管理任務(wù)的WBS 7 6.2 用戶文檔編寫計劃 8 6.2.1 確定目標(biāo)和受眾 9 6.2.2 設(shè)計任務(wù) 10 6.2.3 開發(fā)任務(wù) 10 6.2.4 翻譯和本地化任務(wù) 10 6.2.5 生產(chǎn)任務(wù) 11 6.2.6 變更管理和維護(hù)任務(wù) 11 7 用戶文檔計劃 11 7.1 用戶文檔管理計劃與文檔編制計劃 11 7.2 文檔管理計劃的內(nèi)容 12 7.3 文檔編制計劃的內(nèi)容 12 8 項目啟動 13 8.1 授權(quán)、規(guī)程和規(guī)范 13 8.2 基礎(chǔ)設(shè)施 14 8.3 信息開發(fā)團(tuán)隊 14 8.3.1 角色定義 14 8.3.2 用戶文檔編制的角色示例 15 9 用戶文檔管理控制方法 18 9.1 文檔編制測量 18 9.1.1 用戶文檔產(chǎn)品測量 18 9.1.2 用戶文檔生產(chǎn)率的測量 19 9.1.3 用戶文檔質(zhì)量測量 19 9.1.4 過程改進(jìn)測量 20 9.2 文檔估算 20 10 管理控制在文檔中的應(yīng)用 21 10.1 目的和成果 21 10.2 變更管理 21 10.3 進(jìn)度和成本控制 21 10.4 資源管理 22 10.4.1 項目溝通 22 10.4.2 管理文檔團(tuán)隊成員和供方 22 10.4.3 管理翻譯服務(wù) 22 10.5 質(zhì)量管理 23 10.5.1 管理產(chǎn)品質(zhì)量---評審和測試 23 10.5.2 風(fēng)險和問題管理 23 10.5.3 過程改進(jìn) 23 附錄A (資料性附錄) 文檔編寫計劃示例 24 附錄B(規(guī)范性附錄) 信息管理和軟件文檔管理過程 31 參考文獻(xiàn) 34 |
暫未檢測到相關(guān)機(jī)構(gòu),邀您申請入駐~
暫未檢測到相關(guān)機(jī)構(gòu),邀您申請入駐~
暫未檢測到相關(guān)機(jī)構(gòu),邀您申請入駐~