工作产品 (工件):用户支持材料
该工件由帮助最终用户学习、使用、操作和维护产品的材料组成。
用途

该工作产品用于指导用户如何使用产品并提供支持。

关系
角色负责人: 修改者:
输入至必需:
可选: 外部:
输出自
主要描述

具有与用户交互的界面的任何系统通常都需要有最终用户支持材料;尽管最终用户支持材料即使是在需要记录 API 时都是适用和有用的,但如果系统主要是嵌套的并且几乎或根本没有用户界面,则仍然可以省略该工作产品。

该工作产品常常包含以下文档或工作产品中的一项或多项:

  • 用户指南
  • 操作指南
  • 维护指南
  • 在线演示
  • 联机帮助系统
  • 上下文相关的帮助
  • 发行说明

附加信息

用户文档提供了有关如何使用软件的指示信息。为所有类型的用户提供文档。

使用用例作为用户指南的基础。

用户手册可以由技术文档编写者借助开发人员提供的信息编写,或者可以由测试团队编写,测试团队的成员可能站在用户的角度进行理解。

将用户手册的编写任务分配给测试团队的一个理由是,这样它的编写可以与开发同步,并能尽早地取得进展,以作为评估条件的切实的和相关的反映。可在项目的早期迭代阶段发现并纠正用户接口和用例模型中的错误和不良状况,此时进行更改成本相对较低。

通过编写用户手册,测试员将在开始任何整个范围的测试之前很好地逐渐了解系统。 而且,它为测试计划和测试用例,以及为自动测试套件的构造提供了一个必需的基础。

在开发循环的什么阶段开始生成用户手册取决于系统的类型。具有复杂接口或者大量用户交互的系统将需要用户手册的早期版本,以及接口的早期原型。人员界面很少的嵌入式系统可能不需要很早就开始编写用户文档。



属性
可选
已计划Yes