前言 Ⅲ
引言 Ⅳ
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
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
