任务：开发支持文档

此类文档供产品支持和IT运维人员使用，由他们定期答复特定产品最终用户的问题和故障、或者确定某个事件的原因缺陷或遗漏的需求导致。

规程：部署

用途

此任务的目的是确保那些负责支持系统的人员在产品部署到生产环境后，拥有对产品的足够信息以高效的执行他们的工作。

关系

角色

主执行者:

其他执行者:

输入

必需:

可选:

输出

主要描述

支持文档往往是文档工作中最容易忽视的方面。任何有机会为最终用户提供产品支持的人员都将理解有效的、良好编写的支持文档的重要性。此文档本质上往往是技术性的，并且和用户或产品文档有显著的不同，用户或产品文档通常是为外行人员编写的。

开发团队应该尽自己最大的努力来保证那些执行IT支持的人员拥有支持应用所需的合适数量和相关类型的必要信息，无论他们是提供层1、层2，还是层3的支持。支持文档的开发常常基于这三个不同的支持类别。代码注释的有效程度以及这些注释被发现和可理解的容易程度有助于支持文档的质量和数量。

步骤

确定支持文档的内容

此步骤常常是开发团队的挑战，因为他们必须将自己放在IT支持人员的位置以开发合适类型和合适数量的有用内容。拜访支持组织并询问他们在每次发布时希望获得何种类型的文档是有益的。你可能惊讶于他们所说，并且这可以使你的文档编写工作更加容易，如果你确切的知道他们需要哪些类型的信息。

因为每个产品都是不同的，也因为每个流程或IT支持组织有不同的需要，不可能为支持文档列出建议的内容。然后，每一个流程程序应该为那些支持程序的开发团队创建支持文档标准。

利用可用的材料

在开发团队的发布计划中定义支持文档的范围。那些对支持文档内容有帮助的原材料包括：

编写支持文档

基于之前的步骤，编写支持文档。执行此步骤的一种方式是在发布sprint/迭代中将文档的不同章节（由之前的“确定支持文档内容”步骤决定）作为sprint/迭代的任务分配给开发团队成员。

执行质量审核

当整合支持文档时，在发布sprint/迭代中计划并实施质量审查，来保证此文档拥有充分的数量和质量。在质量审查的基础上更新并改进支持文档。

交付支持文档

在发布结束时，向部署经理交付完整的支持文档。确保流程程序中拥有以及时的方式同IT运维支持组织进行沟通的计划。

This program and the accompanying materials are made available under the
Eclipse Public License V1.0, which accompanies this distribution.