GB/T 32424-2015系統(tǒng)與軟件工程用戶文檔的設計者和開發(fā)者要求

ICS35080

L77.

中華人民共和國國家標準

GB/T32424—2015

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

用戶文檔的設計者和開發(fā)者要求

Systemsandsoftwareengineering—

Requirementsfordesignersanddevelopersofuserdocumentation

(ISO/IEC26514:2008,MOD)

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

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

中國國家標準化管理委員會

GB/T32424—2015

目次

前言

…………………………Ⅲ

引言

…………………………Ⅳ

范圍

1………………………1

符合性

2……………………1

概述

2.1…………………1

符合性的應用

2.2………………………2

符合性場景

2.3…………………………2

規(guī)范性引用文件

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

術語和定義

4………………2

系統(tǒng)軟件生存周期中的用戶文檔編制過程

5/……………7

項目的需求目標和約束條件

6、……………9

概述

6.1…………………9

項目目標

6.2……………9

用戶文檔要求和約束

6.3………………10

項目的目標和約束條件

6.4……………11

用戶和易用性目標

6.5…………………12

訪談技術聯(lián)絡人和其他專家

6.6………………………13

項目策劃

6.7……………13

文檔建議書

6.8…………………………16

分析和設計

7………………17

概述

7.1…………………17

受眾和任務分析

7.2……………………17

用戶文檔設計

7.3………………………21

開發(fā)與評審

8………………22

概述

8.1…………………22

文檔原型和草稿

8.2……………………22

文檔的評價

8.3…………………………24

文檔測試

8.4……………27

制作

9………………………28

概述

9.1…………………28

最終的合編和評審

9.2…………………28

批準

9.3…………………29

配置管理

9.4……………29

更新和維護

9.5…………………………29

文檔結構

10………………29

概述

10.1………………29

Ⅰ

GB/T32424—2015

文檔的整體結構

10.2…………………30

取決于受眾需求的文檔結構

10.3……………………31

屏顯文檔的主題的大小

10.4…………32

用戶文檔的部件

10.5…………………32

用戶文檔部件的布局

10.6……………33

用戶文檔的信息內容

11…………………34

概述

11.1………………34

信息的完備性

11.2……………………34

信息的準確性

11.3……………………34

標識數據的內容

11.4…………………34

文檔使用的信息

11.5…………………35

操作概念

11.6…………………………35

軟件一般使用的信息

11.7……………36

規(guī)程和教程的信息

11.8………………37

關于軟件指令的信息

11.9……………38

數據輸入域的解釋

11.10………………39

錯誤消息和問題解決方案的內容

11.11………………39

警告和注意事項的內容

11.12…………40

術語信息

11.13…………………………40

相關信息來源的信息

11.14……………41

用戶提供的內容

11.15…………………41

附錄資料性附錄文檔的呈現格式

A()…………………43

附錄資料性附錄用戶文檔檢查表

B()…………………66

附錄資料性附錄文檔編制過程的要求條款和檢查表

C()……………71

附錄資料性附錄文檔產品的要求條款和檢查表

D()…………………74

參考文獻

……………………78

Ⅱ

GB/T32424—2015

前言

本標準按照給出的規(guī)則起草

GB/T1.1—2009。

本標準使用重新起草法修改采用系統(tǒng)與軟件工程用戶文檔的設計者和開

ISO/IEC26514:2008《

發(fā)者要求英文版

》()。

本標準與的技術性差異如下

ISO/IEC26514:2008:

將的第章移至附錄作為資料性附錄

———ISO/IEC26514:200812A,。

刪除了的附錄附錄和附錄

———ISO/IEC26514:2008A、BC。

刪除了的附錄

———ISO/IEC26514:2008D。

刪除了正文部分有關英語語言習慣的內容及格式的要求及相關示例

———ISO/IEC26514:2008。

請注意本文件的某些內容可能涉及專利本文件的發(fā)布機構不承擔識別這些專利的責任

。。

本標準由全國信息技術標準化技術委員會提出并歸口

(SAC/TC28)。

本標準起草單位國家網絡軟件產品質量監(jiān)督檢驗中心濟南中國電子技術標準化研究院廣州

:()、、

廣軟信息系統(tǒng)管理咨詢有限公司上海計算機軟件技術開發(fā)中心

、。

本標準主要起草人楊福濤黃姍姍孟憲勇張彬張雪莉袁肅蓉劉新蔡立志劉振宇胡蕓

:、、、、、、、、、。

Ⅲ

GB/T32424—2015

引言

應用軟件的每一個用戶都需要關于該軟件如何幫助其完成任務的準確信息文檔可能是用戶可看

。

到的首個有形物品因此它會影響用戶對該軟件產品的第一印象如果文檔以一種便捷的方式提供信

,,。

息并且信息易于查找和理解那么用戶就能夠迅速地熟練使用該軟件產品因此設計良好的文檔不

,,。,

僅能幫助用戶減少培訓和支持的成本而且能提高產品生產商及供應商的聲譽

,、。

盡管軟件開發(fā)者致力于將用戶界面設計得非常直觀以使用戶不再需要單獨的文檔但這幾乎是不

,,

可能的如今的軟件提供越來越健壯的功能不僅在應用程序內在各應用程序間也進行信息的智能交

。,,

換進一步說大部分的軟件設計包含了潛在的規(guī)則計算或算法當用戶使用該軟件時會影響其獲得

。,、,,

的結果這些潛在的編程技術只有通過艱苦的測試才能被用戶識別基于這些以及更多的原因用戶

。。,

文檔仍然是易于使用的軟件產品的一個主要構成部分

。

文檔編制常被當作軟件實現之后才做的工作然而對于高質量的軟件文檔來說其開發(fā)應被視為

。,,

軟件生存周期過程的一個組成部分想要做好文檔編制或信息管理工作量會大到其本身就需要過程

。,

計劃

。

設計和開發(fā)文檔是軟件生存周期過程的一部分本標準幫助系統(tǒng)和軟件工

,ISO/IEC15288:2008《

程系統(tǒng)生存周期過程或系統(tǒng)和軟件工程軟件生存周期過程的使用者設計

》ISO/IEC12207:2008《》

和開發(fā)文檔它從文檔開發(fā)者的立場定義了文檔過程

。。

除了定義標準過程外本標準也涵蓋了文檔產品本標準規(guī)定了文檔的結構內容及格式也為用

,。、,

戶文檔的呈現格式提供了翔實的指導

。

早期的標準傾向于將文檔編制過程的結果視為一本單獨的書或多卷集可以一次性交付逐漸地

,。,

文檔設計者意識到大部分用戶文檔來自先前已開發(fā)的信息單一來源文檔的可控復用改編后用于軟

(),

件的新版本或用于展現在各種屏幕和印刷媒體上盡管本標準沒有描述如何建立內容管理系統(tǒng)

。

簡稱但是文檔編制組織仍可將其用于編制單一來源的文檔

(contentmanagementsystem,CMS),。

本標準適用于印刷文檔和屏顯文檔與生成文檔的軟件工具無關其大部分指導內容適用于系統(tǒng)

,。

的用戶文檔包括硬件和軟件用戶文檔用于確保文檔的一致性完備性準確性和可用性

,,、、。

Ⅳ

GB/T32424—2015

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

用戶文檔的設計者和開發(fā)者要求

1范圍

本標準規(guī)定了兩方面內容

:

過程標準規(guī)定用戶文檔的編制過程

a),;

文檔產品標準規(guī)定對用戶文檔結構和信息內容的要求

b),。

本標準的第章第章規(guī)定了用戶文檔設計者和開發(fā)者的文檔編制過程包括建立用戶需要

5~9。:

的信息確定信息呈現給用戶的方式準備信息并使信息可用這一過程不限于生存周期的設計與開發(fā)

、、。

階段還包括貫穿信息管理和文檔編制過程的活動

,。

第章和第章規(guī)定了對用戶文檔的結構和信息內容的要求適用于軟件系統(tǒng)用戶在工作環(huán)境

1011。

中使用的印刷文檔和屏顯文檔包括印刷的用戶手冊在線幫助教程和用戶參考文檔

,、、。

附錄給出了適用于英文版本的用戶文檔的呈現格式附錄附錄附錄分別提供了用戶文

A,B、C、D

檔檢查表要求條款和文檔編制過程檢查表以及要求條款和文檔產品的檢查表

、。

盡管本標準未覆蓋以下類型文檔的所有方面但對于其開發(fā)可能有所幫助

,:

除軟件以外的產品的文檔

a);

使用了動畫視頻音頻的多媒體系統(tǒng)

b)、、;

基于計算機的培訓包和正