任务:开发用户文档
每个发布都必须开发并维护用户文档,以使产品终端用户知道如何有效操作系统。
规程:部署
用途

此任务的目的是为已发布到生产环境中的产品的终端用户提供有用的信息。

关系
角色主执行者: 其他执行者:
输入必需:
可选:
    输出
      主要描述

      用户文档可以包含全部或部分用户手册(电子版或印刷版)、教程、常见问题(FAQ)、在线帮助文件、安装说明、操作过程、等等。用户文档通常被作为培训材料的基础。如果用户文档的质量很差,那么培训材料也不可能更好。

      缺少良好的用户文档,即使系统可能被开发团队良好的开发,可能也无法满足最终用户的期望,因为他们无法有效的操作应用。

      步骤
      确定用户文档内容

      用户文档通常包含广泛的内容,如:

      • 用户手册(电子版或印刷版)
      • 教程
      • 常见问题(FAQ)
      • 在线帮助
      • 安装和配置说明
      • 操作流程

      针对你的产品和发布,确定团队将要开发和交付的用户文档类型。

      利用产品文档

      重用能从产品文档中利用的材料。如果在产品文档中花费了充足的时间和注意力,你应该能够从中利用大量的资料来开发用户文档。 由于在产品文档中仅记录了特性(以及可能包含某些非功能需求),所有只有这些可以被利用。然而,产品文档常常为用户文档提供了一个不错的框架。

      利用其它材料

      在发布过程中开发的其它材料可能为用户文档提供了优秀的输入,如:

      • 用户故事
      • 测试用例
      • 故事版
      • 测试场景
      • 架构备忘录
      • 之前开发的培训材料

      这些材料中的每一种都可能包含不需要重新创建的内容。发挥你的想象力寻找那些有助于团队开发用户文档的其它资料源。

      编写用户文档内容

      基于之前的步骤,编写用户文档。执行此步骤的一种方式是在发布Sprint/迭代中将文档的不同章节作为Sprint/迭代的任务分配给团队成员。

      执行质量审查

      当整合用户文档时,在发布Sprint/迭代中计划并实施质量审查,以确保该文档拥有充分的数量和质量。基于质量审查的结果更新并改进用户文档。

      交付用户文档

      在发布结束前,向部署经理交付完整的用户文档。确保流程程序拥有和最终用户沟通用户文档的计划。