软件验收文档清单_如何编写有效的文档检查清单

软件验收文档清单

急于发布文档，您还有很多工作要做。 您可能会错过一些东西。 那可能是一个小东西，或者是一个大东西。 但是为什么要抓住这个机会呢？

发行清单可以帮助您避免犯错。 它可以帮助您提高发布过程的效率。 精心设计的清单，无论是在纸上还是在屏幕上，都可以确保文档发布顺利进行，并且您不会错过任何东西。

具有强大功能的简单列表

清单应该是任何技术作者工具包的一部分。 Atul Gawande在他的《清单宣言》中写道：

...很显然，像清单这样简单的事情可能会带来实质性的帮助。 我们可能会承认错误和疏忽。但是，我们认为我们的工作太复杂了，无法简化为清单。

清单的主要好处（特别是对于技术作家而言）是，它可以帮助您避免尽可能多的错误和疏忽。

有效清单的要素

一个有效的清单听起来很容易创建，但事实并非如此。 有效的清单并非简单的任务清单。 这是您需要做的事情的重点清单。 在这种情况下，这就是将文档发布给用户所需要做的。 您的清单应仅包含您需要的信息，并且一目了然。

发布检查清单应包含哪些内容？ 这将取决于多个因素，包括要发布的文档的数量和类型，要发布的文档的格式以及如何交付文档。

例如，如果您在Wiki上交付文档 ，则无需包括有关将文档签入版本控制或生成PDF的内容。 但是，您将希望列表中有项目来检查链接和格式。

您应该使清单尽可能短。 多短？ 页面。 或更少。 列表中的项目不应该是完整的句子。 相反，请写一些句子片段，例如， 查找缺少的标点或修复断开的链接 。

为什么要使清单简短？ 较短的清单更易于理解和阅读。 您可以一目了然地看到需要执行的操作，而不用通读两行或更多行。 Gawande提供了航空界的一个很好的例子：

试飞员的名单简单，简短，切合实际，足够短以适合索引卡，并逐步检查起飞，飞行和滑行。 它具有飞行员知道该怎么做的东西。

创建清单时，请记住这不是一个方法。 清单在那里提醒您您需要做什么。 您应该已经知道如何执行列表中的任务。 如果不是，您应该学习如何做或在团队中分配任务。

样品发布清单

这是我过去使用的文档发布清单的示例：

• 纳入最终技术审查
• 做最后的编辑审查
• 检查拼写
• 检查版本号
• 将所有分支合并到主节点
• 生成PDF手册
• 建立在线帮助
• 抽查PDF手册以进行格式化
• 抽查在线帮助以进行格式化
• 检查链接
• 撰写发行说明
• 写发布公告
• 将文档发布到项目网站
• 发布发行说明
• 在项目博客上发布发行公告

该清单经过一些调整，在我从事的大约90％的文档项目中为我提供了很好的服务。

即使创建了清单，您也需要经过多次迭代才能将其精简为基本要素。 这意味着要在多个文档版本中对其进行测试，并与您的团队合作，以了解有效的方法和无效的方法，以了解列表中需要的内容和不需要的内容。

每次迭代都要调整清单。 有时可能只需要尝试几次即可得出所需的清单。 否则，您可能需要回到第一个方框。

但是，最后，您将拥有一个有用的工具，该工具可以消除某些紧急情况，以释放文档。

翻译自: https://opensource.com/article/17/8/release-checklists-documentation

软件验收文档清单