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

本标准规定了两方面内容:
a) 过程标准,规定用户文档的编制过程;
b) 文档产品标准,规定对用户文档结构和信息内容的要求。
本标准的第5章~第9章规定了用户文档设计者和开发者的文档编制过程。包括:建立用户需要的信息、确定信息呈现给用户的方式、准备信息并使信息可用。这一过程不限于生存周期的设计与开发阶段,还包括贯穿信息管理和文档编制过程的活动。
第10章和第11章规定了对用户文档的结构和信息内容的要求。适用于软件系统用户在工作环境中使用的印刷文档和屏显文档,包括印刷的用户手册、在线帮助、教程和用户参考文档。
附录A 给出了适用于英文版本的用户文档的呈现格式,附录B、附录C、附录D分别提供了用户文档检查表、要求条款和文档编制过程检查表以及要求条款和文档产品的检查表。
尽管本标准未覆盖以下类型文档的所有方面,但对于其开发可能有所帮助:
a) 除软件以外的产品的文档;
b) 使用了动画、视频、音频的多媒体系统;
c) 基于计算机的培训(CBT)包和正规的培训大纲中使用的专业课程材料;
d) 为安装人员、计算机操作人员或系统管理员等制作而不是为最终用户制作的文档;
e) 描述系统软件内部操作的维护文档;
f) 并入用户界面的文档。
本标准适用于文档的设计者和开发者,包括多种专家:
a) 对文档产品在文档集中的结构和格式进行规划的信息设计师和架构师;
b) 确定预期用户将用软件执行的任务的易用性专家和商业分析师;
c) 开发和编辑用户文档书面内容的人员;
d) 具备电子媒体专业知识的平面设计师;
e) 共同设计文档在屏幕上的呈现形式的用户界面设计师和人类工效学专家。
本标准还可供文档编制过程中的其他角色和利益相关方查阅:
a) 软件开发过程或文档编制过程的管理人员;
b) 阅读由供方编制的文档的需方;
c) 易用性测试人员、文档评审人员和领域专家;
d) 屏显文档创建工具的开发者;
e) 确定原则使文档更易于理解和易于使用的人为因素专家。