Baklib 知识分享|文档生命周期：确保您的文档产出效率

一个多世纪以来，文档一直是任何产品或服务的支柱。它是用户在使用您的产品、应用程序、网站或其他软件服务时所引用的内容。但在现代，随着大多数帮助或支持文档从传统形式转移到数字形式，对效率的需求比以往任何时候都更加明显。此外，与传统的支持方式相比，“自助服务”的概念正变得更加实际和相关。

如何数字化地呈现信息将决定您的产品或服务的可用性和用户的问题解决方案。用户友好的文档还可以帮助他们在以后需要引用时更快地重新使用您的产品。

为了确保您的文档是充分的和最新的，您应该将其视为一个生命周期过程。本文将讨论文档生命周期以及如何将这些原则应用到您的组织中。

什么是文档生命周期?

文档生命周期是在整个组织中管理文档的一种战略方法。考虑文档的生命周期是必要的，因为它是双向的。在一端，您拥有创建文档过程的产品和内容所有者。另一方面，你拥有用户，也就是使用你的产品的人。如果没有考虑到这两个方面，你的文档可能是无效的和过时的，花费你的钱和用户粘性。

文档的生命周期不是单一的、一次性的事件。这是一个持续的过程，从产品的第一行代码开始，到产品退役结束。

在整个过程中有多个阶段应该考虑文档。如果您记住这些阶段，并有一个管理文档的有效计划，那么您将拥有一个易于使用且对客户有帮助的产品。

根据传统或现代方法的不同，文档生命周期的阶段可以从 4 个到 10 个不等。

传统的文档生命周期

创作→批准→储存→分发→存档/保存→销毁/报废

现代文档生命周期

现代的方法考虑使用知识管理工具(如 Baklib)和其他知识库提供程序来提供文档。使用这些平台将使存储、分发和保存等过程自动化。

这种数字知识管理方法将缩小文档生命周期的各个阶段。

定义→研究→草案→回顾→撤退

定义:在编写任何文档之前

文档生命周期的第一个阶段是定义。在此阶段，产品和内容所有者将与他们的团队坐下来讨论以下方面

• 必要性:你的文件的目的是什么?

• 产品:你需要包括什么类型的信息?

• 内容策略:你将如何组织和呈现信息?

• 格式:您将使用哪种格式?

• 写作风格:你的文档将采用什么样的语气?

• 工具:您会使用特定的程序来创建文档吗?

• 工作流程:您的团队将如何协作和管理文档?

• 度量标准:您将使用什么关键性能度量标准来度量文档的有效性?

• 审批流程:文件如何审批，谁负责?

• 沟通:您将如何沟通文档的更改?

在上述一系列问题中，术语“你”和“你的”是指负责文件的人员。这可以是技术作者、产品负责人、编辑或其他特定组织的角色。同样的条件也适用于这篇博文。

大多数情况下，上面提到的所有必要条件都已经定义好了，您必须遵守所设置的原则。

研究:在写作前了解你的受众和产品

文档生命周期的下一个阶段是研究。在这里，您应该尽可能多地获取关于将要记录的产品和用户的信息。这可以让你决定哪些信息需要包含，哪些不需要。

在这个阶段，你需要借助调查来锁定你的受众。你最好尽可能多地了解他们的信息。你应该问这样的问题:谁是你的观众?他们的痛点是什么?他们目前在哪里寻找解决方案?

在此阶段进行的研究将为生命周期的其余部分提供信息，并允许您创建更好的文档。

草稿:在研究的基础上开始撰写文档

文档生命周期的第三个阶段是起草。在这里，您可以将在研究阶段学到的所有东西用于创建实际的文档。这是文档生命周期中的一个关键阶段，因为您可以在这里决定包含什么信息以及如何表示这些信息。

你决定包含的信息将决定你的文档是否有效。在起草文档时，一定要把读者记在心里。

在此阶段，您希望确保文档关注用户的需求。

• 你的产品或服务的核心概念是什么?

• 受众需要什么信息?

• 什么样的语气对文档最有效?

•  什么样的格式最适合你的观众?

• 您将使用什么工具来创建文档?

•  需要什么辅助图像/视频/音频工件?

一旦满足了所有要求，就开始实际编写内容。这是文档的核心焦点所在，也是作者花费大部分时间的地方。

尽管老派作家可能不同意，但有大量的写作辅助工具可用;有些人甚至使用人工智能来辅助写作。我们把这一点留给作者自己的判断或组织的实践。

一个直观的知识库软件，可以轻松添加您的内容，并将其与任何应用程序集成。试试 Baklib 吧!

回顾:让人们使用你写的文档

文档生命周期的第四个阶段是审核。在这里，您的团队将检查他们所编写的文档，以确保它是准确和有用的。这种审查可以在内部完成，也可以与一个小型试点小组一起完成。

当您回顾您的文档时，请考虑:

l  什么需要修复?

l  需要改变什么?

l  还有什么可以弥补的?

l  什么是不需要的?

l  是否交付了预期的上下文?

l  像媒体和附件这样的辅助构件是否相关?

在这个阶段，您需要确保获得关于文档的最多反馈。你要想办法让它对你的观众更有效、更有价值。对你的内容有一双新鲜的眼睛总是有帮助的。

发布 ——每个评论的所有反馈都经过了修改，文章也发布了

这些评审允许我们为客户制作最优和高效的文档。您可以阅读一篇关于为知识库创建文档工作流的深入文章。 阅读这篇博客→

撤销:意识到什么没用，然后进行适当的删除

文档生命周期的最后一个阶段是撤销。在您发布产品文档之后，工作并不会结束。

因为它是一个循环，文档应该由作者经常回顾。

在这里，您需要后退一步，查看您对文档所做的工作，并确保它是您可以自豪地向客户展示的内容。您可能想要反思整个文档生命周期，并检查哪些是有效的，哪些是无效的。

在这个阶段，您需要查看文档，确保它符合您的标准。您还需要确保它正在帮助您的客户解决他们的问题。如果是，继续做你正在做的事情。如果不是，那就把它当作一个做出改变的机会。

例如，在 Baklib，我们在文章的底部有一个反馈区，读者可以给文章投喜欢，并添加评论，指出文档中缺少的内容。技术文档作者会收到反馈的通知，对反馈进行评估，并处理文章评论。

在这一点上，Baklib 的内置数据看板功能非常方便。

文档生命周期的这个阶段确保您的文档不会过时或不准确，不会难懂，也不会缺少或断开链接。如果所有提到的标准都得到了满足，那么文档生命周期就完成了一个完整的阶段循环。

循环完成了，文档又回到了起点，为将来的更新做好准备。