GB/T 32424-2015系统与软件工程用户文档的设计者和开发者要求

ICS35080

L77.

中华人民共和国国家标准

GB/T32424—2015

系统与软件工程

用户文档的设计者和开发者要求

Systemsandsoftwareengineering—

Requirementsfordesignersanddevelopersofuserdocumentation

(ISO/IEC26514:2008,MOD)

2015-12-31发布2016-07-01实施

中华人民共和国国家质量监督检验检疫总局发布

中国国家标准化管理委员会

GB/T32424—2015

目次

前言

…………………………Ⅲ

引言

…………………………Ⅳ

范围

1………………………1

符合性

2……………………1

概述

2.1…………………1

符合性的应用

2.2………………………2

符合性场景

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

规范性引用文件

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

术语和定义

4………………2

系统软件生存周期中的用户文档编制过程

5/……………7

项目的需求目标和约束条件

6、……………9

概述

6.1…………………9

项目目标

6.2……………9

用户文档要求和约束

6.3………………10

项目的目标和约束条件

6.4……………11

用户和易用性目标

6.5…………………12

访谈技术联络人和其他专家

6.6………………………13

项目策划

6.7……………13

文档建议书

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

分析和设计

7………………17

概述

7.1…………………17

受众和任务分析

7.2……………………17

用户文档设计

7.3………………………21

开发与评审

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

规程和教程的信息

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

前言

本标准按照给出的规则起草

GB/T1.1—2009。

本标准使用重新起草法修改采用系统与软件工程用户文档的设计者和开

ISO/IEC26514:2008《

发者要求英文版

》()。

本标准与的技术性差异如下

ISO/IEC26514:2008:

将的第章移至附录作为资料性附录

———ISO/IEC26514:200812A,。

删除了的附录附录和附录

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

删除了的附录

———ISO/IEC26514:2008D。

删除了正文部分有关英语语言习惯的内容及格式的要求及相关示例

———ISO/IEC26514:2008。

请注意本文件的某些内容可能涉及专利本文件的发布机构不承担识别这些专利的责任

。。

本标准由全国信息技术标准化技术委员会提出并归口

(SAC/TC28)。

本标准起草单位国家网络软件产品质量监督检验中心济南中国电子技术标准化研究院广州

:()、、

广软信息系统管理咨询有限公司上海计算机软件技术开发中心

、。

本标准主要起草人杨福涛黄姗姗孟宪勇张彬张雪莉袁肃蓉刘新蔡立志刘振宇胡芸

:、、、、、、、、、。

Ⅲ

GB/T32424—2015

引言

应用软件的每一个用户都需要关于该软件如何帮助其完成任务的准确信息文档可能是用户可看

。

到的首个有形物品因此它会影响用户对该软件产品的第一印象如果文档以一种便捷的方式提供信

,,。

息并且信息易于查找和理解那么用户就能够迅速地熟练使用该软件产品因此设计良好的文档不

,,。,

仅能帮助用户减少培训和支持的成本而且能提高产品生产商及供应商的声誉

,、。

尽管软件开发者致力于将用户界面设计得非常直观以使用户不再需要单独的文档但这几乎是不

,,

可能的如今的软件提供越来越健壮的功能不仅在应用程序内在各应用程序间也进行信息的智能交

。,,

换进一步说大部分的软件设计包含了潜在的规则计算或算法当用户使用该软件时会影响其获得

。,、,,

的结果这些潜在的编程技术只有通过艰苦的测试才能被用户识别基于这些以及更多的原因用户

。。,

文档仍然是易于使用的软件产品的一个主要构成部分

。

文档编制常被当作软件实现之后才做的工作然而对于高质量的软件文档来说其开发应被视为

。,,

软件生存周期过程的一个组成部分想要做好文档编制或信息管理工作量会大到其本身就需要过程

。,

计划

。

设计和开发文档是软件生存周期过程的一部分本标准帮助系统和软件工

,ISO/IEC15288:2008《

程系统生存周期过程或系统和软件工程软件生存周期过程的使用者设计

》ISO/IEC12207:2008《》

和开发文档它从文档开发者的立场定义了文档过程

。。

除了定义标准过程外本标准也涵盖了文档产品本标准规定了文档的结构内容及格式也为用

,。、,

户文档的呈现格式提供了翔实的指导

。

早期的标准倾向于将文档编制过程的结果视为一本单独的书或多卷集可以一次性交付逐渐地

,。,

文档设计者意识到大部分用户文档来自先前已开发的信息单一来源文档的可控复用改编后用于软

(),

件的新版本或用于展现在各种屏幕和印刷媒体上尽管本标准没有描述如何建立内容管理系统

。

简称但是文档编制组织仍可将其用于编制单一来源的文档

(contentmanagementsystem,CMS),。

本标准适用于印刷文档和屏显文档与生成文档的软件工具无关其大部分指导内容适用于系统

,。

的用户文档包括硬件和软件用户文档用于确保文档的一致性完备性准确性和可用性

,,、、。

Ⅳ

GB/T32424—2015

系统与软件工程

用户文档的设计者和开发者要求

1范围

本标准规定了两方面内容

:

过程标准规定用户文档的编制过程

a),;

文档产品标准规定对用户文档结构和信息内容的要求

b),。

本标准的第章第章规定了用户文档设计者和开发者的文档编制过程包括建立用户需要

5~9。:

的信息确定信息呈现给用户的方式准备信息并使信息可用这一过程不限于生存周期的设计与开发

、、。

阶段还包括贯穿信息管理和文档编制过程的活动

,。

第章和第章规定了对用户文档的结构和信息内容的要求适用于软件系统用户在工作环境

1011。

中使用的印刷文档和屏显文档包括印刷的用户手册在线帮助教程和用户参考文档

,、、。

附录给出了适用于英文版本的用户文档的呈现格式附录附录附录分别提供了用户文

A,B、C、D

档检查表要求条款和文档编制过程检查表以及要求条款和文档产品的检查表

、。

尽管本标准未覆盖以下类型文档的所有方面但对于其开发可能有所帮助

,:

除软件以外的产品的文档

a);

使用了动画视频音频的多媒体系统

b)、、;

基于计算机的培训包和正