GB/T 16680-2015系統(tǒng)與軟件工程用戶文檔的管理者要求

ICS35080

L77.

中華人民共和國(guó)國(guó)家標(biāo)準(zhǔn)

GB/T16680—2015/ISO/IEC265112011

代替:

GB/T16680—1996

系統(tǒng)與軟件工程

用戶文檔的管理者要求

Systemsandsoftwareengineering—Requirementsfor

managersofuserdocumentation

(ISO/IEC26511:2011,IDT)

2015-12-31發(fā)布2016-07-01實(shí)施

中華人民共和國(guó)國(guó)家質(zhì)量監(jiān)督檢驗(yàn)檢疫總局發(fā)布

中國(guó)國(guó)家標(biāo)準(zhǔn)化管理委員會(huì)

GB/T16680—2015/ISO/IEC265112011

:

目次

前言

…………………………Ⅲ

引言

…………………………Ⅳ

范圍

1………………………1

符合性

2……………………2

符合性定義

2.1…………………………2

符合性場(chǎng)景

2.2…………………………2

規(guī)范性引用文件

3…………………………2

術(shù)語和定義

4………………2

生存周期過程中的用戶文檔管理

5………………………5

軟件生存周期中的用戶文檔管理

5.1…………………5

組合管理和內(nèi)容管理

5.2………………6

信息管理策略與方針

5.3………………6

文檔管理策劃

6……………7

文檔管理任務(wù)的

6.1WBS………………7

用戶文檔編寫計(jì)劃

6.2…………………8

確定目標(biāo)和受眾

6.2.1………………9

設(shè)計(jì)任務(wù)

6.2.2………………………10

開發(fā)任務(wù)

6.2.3………………………10

翻譯和本地化任務(wù)

6.2.4……………10

生產(chǎn)任務(wù)

6.2.5………………………11

變更管理和維護(hù)任務(wù)

6.2.6…………11

用戶文檔計(jì)劃

7……………11

用戶文檔管理計(jì)劃與文檔編制計(jì)劃

7.1………………11

文檔管理計(jì)劃的內(nèi)容

7.2………………12

文檔編制計(jì)劃的內(nèi)容

7.3………………12

項(xiàng)目啟動(dòng)

8…………………13

授權(quán)規(guī)程和規(guī)范

8.1、…………………13

基礎(chǔ)設(shè)施

8.2……………14

信息開發(fā)團(tuán)隊(duì)

8.3………………………14

角色定義

8.3.1………………………14

用戶文檔編制的角色示例

8.3.2……………………15

用戶文檔管理控制方法

9…………………18

文檔編制測(cè)量

9.1………………………18

用戶文檔產(chǎn)品測(cè)量

9.1.1……………18

用戶文檔生產(chǎn)率的測(cè)量

9.1.2………………………19

用戶文檔質(zhì)量測(cè)量

9.1.3……………19

Ⅰ

GB/T16680—2015/ISO/IEC265112011

:

過程改進(jìn)測(cè)量

9.1.4…………………20

文檔估算

9.2……………20

管理控制在文檔中的應(yīng)用

10……………21

目的和成果

10.1………………………21

變更管理

10.2…………………………21

進(jìn)度和成本控制

10.3…………………21

資源管理

10.4…………………………22

項(xiàng)目溝通

10.4.1……………………22

管理文檔團(tuán)隊(duì)成員和供方

10.4.2…………………22

管理翻譯服務(wù)

10.4.3………………22

質(zhì)量管理

10.5…………………………23

管理產(chǎn)品質(zhì)量評(píng)審和測(cè)試

10.5.1———……………23

風(fēng)險(xiǎn)和問題管理

10.5.2……………23

過程改進(jìn)

10.5.3……………………23

附錄資料性附錄文檔編寫計(jì)劃示例

A()………………24

附錄規(guī)范性附錄信息管理和軟件文檔管理過程

B()…………………31

參考文獻(xiàn)

……………………34

Ⅱ

GB/T16680—2015/ISO/IEC265112011

:

前言

本標(biāo)準(zhǔn)按照給出的規(guī)則起草

GB/T1.1—2009。

本標(biāo)準(zhǔn)代替軟件文檔管理指南

GB/T16680—1996《》。

本標(biāo)準(zhǔn)對(duì)進(jìn)行修訂與相比主要變化如下

GB/T16680—1996,GB/T16680—1996,:

名稱改為系統(tǒng)與軟件工程用戶文檔的管理者要求

———“”;

增加了第章符合性

———2;

刪除了第章軟件文檔的作用

———4;

刪除了第章管理者的作用

———5;

增加了軟件生存周期過程中的用戶文檔管理

———5.1;

增加了第章文檔管理策劃

———6;

第章制定文檔編制策略見版調(diào)整為信息管理策略與方針

———6(1996)5.3;

刪除了第章制定文檔編制標(biāo)準(zhǔn)和指南

———7;

增加了第章用戶文檔計(jì)劃

———7;

增加了第章項(xiàng)目啟動(dòng)

———8;

原標(biāo)準(zhǔn)第章文檔編制計(jì)劃見版調(diào)整為用戶文檔編寫計(jì)劃

———8(1996)6.2;

刪除了第章制定文檔規(guī)程

———9;

增加了第章用戶文檔管理控制方法

———9;

增加了第章管理控制在文檔中的應(yīng)用

———10;

人員見版調(diào)整為信息開發(fā)團(tuán)隊(duì)

———10.1(1996)8.3;

設(shè)備見版調(diào)整為基礎(chǔ)設(shè)施

———10.2(1996)8.2。

本標(biāo)準(zhǔn)使用翻譯法等同采用系統(tǒng)與軟件工程用戶文檔的管理者要求

ISO/IEC26511:2011《》。

本標(biāo)準(zhǔn)做了以下編輯性修改

:

為方便使用將中的和節(jié)錄以表形式給出

———,ISO/IEC12207:20086.3.67.2.1,B.1。

請(qǐng)注意本文件的某些內(nèi)容可能涉及專利本文件的發(fā)布機(jī)構(gòu)不承擔(dān)識(shí)別這些專利的責(zé)任

。。

本標(biāo)準(zhǔn)由全國(guó)信息技術(shù)標(biāo)準(zhǔn)化技術(shù)委員會(huì)提出并歸口

(SAC/TC28)。

本標(biāo)準(zhǔn)的起草單位珠海南方軟件網(wǎng)絡(luò)評(píng)測(cè)中心中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究院北京師范大學(xué)珠海

:、、

分校國(guó)家網(wǎng)絡(luò)軟件產(chǎn)品質(zhì)量監(jiān)督檢驗(yàn)中心濟(jì)南

、()。

本標(biāo)準(zhǔn)的主要起草人侯建華梁勇孫瑋倪玉華彭宇帆梁建新黃兆森黃姍姍相福民

:、、、、、、、、、

張雪莉何春江楊靜于文張燕張佳佳

、、、、、。

的歷次版本發(fā)布情況為

GB/T16680:

———GB/T16680—1996。

Ⅲ

GB/T16680—2015/ISO/IEC265112011

:

引言

軟件用戶文檔的有效管理是必不可少的工作它能確保用戶文檔可用準(zhǔn)確并能高效地形成與軟

,、,

件相匹配的文檔資料在用戶需要時(shí)按時(shí)交付本標(biāo)準(zhǔn)主要討論用戶文檔的管理包括軟件和用戶文檔

,。,

從初始開發(fā)到后續(xù)發(fā)布的整個(gè)過程中的所有用戶文檔管理工作

。

任何使用應(yīng)用軟件的人員都需要準(zhǔn)確了解軟件是如何幫助用戶完成任務(wù)的文檔可能是第一個(gè)呈

。

現(xiàn)在用戶面前的有形產(chǎn)品因此它將影響著用戶對(duì)產(chǎn)品的第一印象如果文檔表現(xiàn)形式便捷很容易查

,。,

找和理解那么用戶可以快速熟練地使用該軟件產(chǎn)品因此文檔編制過程的良好管理不僅能夠幫助用

,。,

戶還有益于降低培訓(xùn)和支持成本同時(shí)也提高了產(chǎn)品生產(chǎn)商和銷售商的聲譽(yù)

,,、。

雖然許多軟件設(shè)計(jì)者希望通過在設(shè)計(jì)中使用戶界面更加直觀的方法來減少獨(dú)立文檔的編寫但是

,

這種方法事實(shí)上幾乎是不可行的用戶文檔是可用的軟件產(chǎn)品的必不可少的組成部分

。。

文檔編制通常被認(rèn)為是軟件完成后的工作然而對(duì)于高質(zhì)量的軟件文檔來說它的編制宜從軟件

。,,

策劃和設(shè)計(jì)階段就開始是軟件生存周期過程的一個(gè)不可缺少的組成部分正確的做法是文檔編制或

,。:

信息管理需要有自己的過程和計(jì)劃來策劃和完成其包含的各項(xiàng)工作內(nèi)容

,。

本標(biāo)準(zhǔn)有助于使用以下兩個(gè)標(biāo)準(zhǔn)的用戶系統(tǒng)和軟件工程系統(tǒng)生存周期

:ISO/IEC15288:2008《

過程和系統(tǒng)和軟件工程軟件生存周期過程幫助他們把管理軟件用戶文

》,ISO/IEC12207:2008《》,

檔作為軟件生存周期中的一部分工作本標(biāo)準(zhǔn)從管理者的角度定義了軟件文檔編制過程用于幫助他

。。

們制定執(zhí)行和評(píng)估用戶文檔的管理工作

、。

注其他系列國(guó)際標(biāo)準(zhǔn)描述的文檔編制和信息管理過程是從文檔設(shè)計(jì)人員開發(fā)人員測(cè)試和評(píng)

:ISO/IEC265NN,/,

審人員需方和供方的觀點(diǎn)闡述的

,。

本標(biāo)準(zhǔn)適用于生產(chǎn)一系列文檔的個(gè)人或組織也適用于開發(fā)單文檔項(xiàng)目的組織同樣適合團(tuán)隊(duì)內(nèi)部

,,

以及外包文檔編制的情況除了用戶手冊(cè)幫助系統(tǒng)以及單獨(dú)軟件產(chǎn)品文檔集的開發(fā)和生產(chǎn)以外它

。,,,

還適用于更廣泛的文檔管理情況包括安裝實(shí)施管理和操作軟件的最終用戶所需要的文檔通常情

,、、。

況下用戶文檔管理者還負(fù)責(zé)用于如下情況的信息內(nèi)容管理的開發(fā)和重用

,():

隨著軟件版本的更新多次更新用戶文檔

———,;

多次重用或調(diào)整信息以支持相關(guān)的軟件產(chǎn)品

———;

用戶文檔多個(gè)版本的翻譯或本地化

———;

同時(shí)管理組織內(nèi)一組不相關(guān)的文檔項(xiàng)目

———。

本標(biāo)準(zhǔn)的目的不是提倡文件的印刷或電子屏幕媒體的使用或任何特定信息管理內(nèi)容管理文

(),、、

檔測(cè)試項(xiàng)目管理工具或協(xié)議的使用而是要求是盡可能的介質(zhì)無關(guān)本標(biāo)準(zhǔn)適用于包含軟件系統(tǒng)的用

,,。

戶文檔編制工作也適用于單獨(dú)的軟件用戶文檔編制工作

,。

Ⅳ

GB/T16680—2015/ISO/IEC265112011

:

系統(tǒng)與軟件工程

用戶文檔的管理者要求

1范圍

本標(biāo)準(zhǔn)支持軟件用戶對(duì)文檔一致性完備性準(zhǔn)確性和可用性的要求它為文檔管理者提供策略

、、。、

策劃執(zhí)行和控制它指明貫穿整個(gè)軟件生存周期的用戶文檔管理過程它也包括用戶文檔管理的關(guān)

、。。

鍵過程即文檔編制計(jì)劃和文檔管理計(jì)劃

,。

本標(biāo)準(zhǔn)提供了軟件文檔編制和用于文檔編制的信息管理過程的概述同時(shí)還描述了用于文檔編制

。

的組合計(jì)劃和內(nèi)容管理具體來說它專注于以下內(nèi)容

。,:

項(xiàng)目啟動(dòng)時(shí)的管理要求包括建立過程和規(guī)范建立基礎(chǔ)設(shè)施建立團(tuán)隊(duì)并列舉用戶文檔團(tuán)隊(duì)

———,,,

所需要的角色

;

文檔管理控制所需的測(cè)量和估算

———;

對(duì)用戶文檔編制工作進(jìn)行管理控制

———;

支持過程的運(yùn)用例如變更管理進(jìn)度和成本控制資源管理質(zhì)量管理和過程改進(jìn)

———,,,,。

參考文獻(xiàn)中所列內(nèi)容對(duì)管理準(zhǔn)備和測(cè)試用戶文檔的過程提供了指南

、。

注1過程中所涉及的文檔管理者和其他的相關(guān)標(biāo)準(zhǔn)有系統(tǒng)和軟件工程對(duì)用戶文檔設(shè)計(jì)

::ISO/IEC26514:2008《

者和開發(fā)者的要求標(biāo)準(zhǔn)采用的標(biāo)準(zhǔn)系統(tǒng)和軟件工程對(duì)

》(IEEE26514—2010,ISO/IEC26514:2008IEEE,

用戶文檔設(shè)計(jì)者和開發(fā)者的要求系統(tǒng)與軟件工程對(duì)用戶文檔測(cè)試者和評(píng)審者的

),ISO/IEC26513:2009《

要求標(biāo)準(zhǔn)采用的標(biāo)準(zhǔn)系統(tǒng)與軟件工程對(duì)用戶文檔測(cè)試

》(IEEE26513:2010,ISO/IEC26513:2009IEEE,

者和評(píng)審者的要求