任务:开发产品文档
因为产品文档在开发工作结束后仍将持续使用,所以趁着功能还在团队成员头脑中新鲜时清晰的将发布中开发的特性文档化非常重要。
规程:部署
用途

此任务的目的是为特定发布中开发的特性文档化记录对客户在产品的整个生命周期中有用的足够信息。

关系
角色主执行者: 其他执行者:
输出
    主要描述

    开发团队成员有时认为文档是理所当然的,有时却对其缺乏足够的考虑。然而,在产品交付后,那些使用和支持系统的客户经常没有足够的信息来有效的管理产品。

    如果开发团队中有技术作者,那么该角色经常会减轻团队开发正式产品文档的负担,并确保这些文档使用了正确的格式和业务语言。如果没有技术作者,那么开发团队和产品负责人必须尽一切努力来创建足够的文档来确保每个发布所开发的特性能够被客户和利益相关人理解并与他们有效的沟通。

    交付专业的开发产品要求开发团队向客户提供精确、详细且全面的产品文档。

    步骤
    识别当前发布的特性

    每个发布都包含在之前sprint或迭代中开发的一系列特性。此特性列表将驱动产品文档的内容表单。这也可能包括某些非功能需求。

    虽然产品文档并不像用户文档那样直接使用,但它是用户文档的基础。该基础也就是为什么此步骤如此重要的原因。

    文档化每个特性

    为每个特性编写全面的描述,并包含合适的屏幕截图,以及特性如何开发的相关信息。

    同利益相关人一起评审产品文档

    安排同关键利益相关人的评审会议,以确保产品文档是足够且包含了产品客户所需的细节。如果要求更多的细节,从利益相关人处引出一个或多个例子来展示他们希望如何准备产品文档。

    需要的话更新产品文档

    基于评审结果,更新产品文档以使其获得适当的批准。

    交付产品文档

    针对此发布版本,向客户和关键利益相关人交付最终的产品文档。必要的话,获取正式的批准。