高效更新内容 轻松享受午餐
浏览：0
巴克励步
技术文档常因产品更新而过时。作者提出利用元数据（如标签）记录文档关联的业务组件，当组件更新时，通过筛选元数据快速生成待更新文档列表，从而高效维护内容时效性，避免依赖繁琐的审核或僵化的分类结构。
几乎所有技术文档撰写者都曾亲身经历过这样的场景：你投入了大量的时间、精力和心血，力求让文档保持最新，却从客户那里得知，你的一份文档已经过时得离谱。果然，当你去查看时，问题就在那里：一张几个月前就已变更的旧截图或一组旧步骤。你以为自己已经捕捉到了所有更新，但这个还是被遗漏了。
一些撰写者试图通过结合发布周期或日历周期进行细致的内容审核来解决这个问题。这确实能解决问题，但过程耗时且繁琐。
多年来，我提炼出了一套灵活的方法，可以用更少的工作量保持文档的时效性。秘诀是什么？利用元数据（Metadata）来记录你的文档讨论了哪些实际业务组件，然后在这些组件更新时，运行报告来生成待更新列表。
如何避免错误地解决这个问题
首先，一个快速的提醒。
我见过很多人试图通过组织结构或层级分类来解决这个问题：把与特定功能、特性、政策、流程或部门相关的一切内容，都放在网站布局的同一个类别或子类别下。
如果你的产品或服务是完全模块化且可以这样操作的，那当然很好。但你可能需要花费数小时、数天、数周甚至数月来寻找一个合适的层级结构。而不可避免地，总会有一些内容无法很好地融入其中，或者产品/服务在几个月后发生变化，你又得重新开始。
第一步：不要混淆你呈现给最终用户的信息架构与你用来识别哪些内容需要更新的分类法或元数据（Metadata）。
通过 Baklib 构建产品文档中心，你可以轻松地为每篇文章添加自定义标签（元数据（Metadata）），例如关联的产品版本、功能模块或更新时间。这样，当产品功能迭代时，你可以利用 Baklib 的强大筛选和报告功能，快速定位所有需要更新的相关文档，而无需受限于固定的目录结构，大大提升了内容维护的效率和灵活性。
知识库和内容创作可以——也应该——是独立的两件事。知识库的结构应该设计得让一个完全的新手也能轻松找到所需信息；而内容创作的分组方式，为了逻辑性更新，其结构通常与此完全不同。它们服务于不同的目的。如果你试图让两者做同样的工作，要么你的最终用户会难以找到信息，要么你自己会陷入困境。
知道何时需要更新
要持续跟进一个不断变化的知识体系可能很困难。即使你没有权限更改工作流程或工具，仅仅通过弄清楚何时需要更新，也能让事情变得简单得多。
客户评价：Baklib DXP 提供最先进的应用程序开发流程。您可以使用 Baklib 的应用程序构建器非常快速地创建应用程序。您可以创建受移动设备、平板电脑和台式机支持的应用程序。您只需要在应用程序构建器中创建项目，无需任何代码即可创建工作流应用程序并请求批准。现在每个人都需要非常快速的应用程序开发，而 Baklib 可以帮助您实现这一目标。它非常容易实现，任何没有太多编码知识的开发人员都可以轻松创建应用程序。现在它具有云集成，这是一个很棒的功能。
所以，问问自己：哪些事件或变化会要求我们更新文档？
1. 需要更新文档的常见事件
面向客户的文档
- 新的产品或课程推出
- 产品或应用功能更新
- 影响行业的法规更新
- 工作流程或联系点更新
- 产品或应用的用户界面更新
- 例如，整个网站重构或品牌重塑
- 技术栈变更
- 更新布局以提高可用性
内部支持文档
- 团队使用的产品或应用程序更新（软件版本，甚至像VPN登录流程等）
- 硬件或基础设施更新（从网络打印机到共享网络驱动器的一切）
- 公司人力资源政策和程序更新
- 公司内部组织结构变更
- 影响行业的法规更新
2. 列一份清单（二次检查可选）
不要只是想想这些事件。请实际列出一份清单。
事实上，要列一份更详细的清单。再问自己一个问题：我的文档中哪些部分会受这些事件影响？
利用这个问题来为每个触发事件补充细节，这样你的清单就能包含每个触发事件可能影响的变化范围。
清单示例
触发事件 受影响部分
| 公司内部重组 | 各业务单元的名称 其业务单元负责人或副总裁 关键职位或联系人列表 您知识库中的任何组织架构图或其他图表 该部门负责的政策或流程 与该部门相关的所有文档 内容标签或知识库的组织结构（取决于当前布局）
你可以采用任何对你有意义的方式组织这些信息。我见过决策树、流程图、Excel电子表格、白板上的涂鸦列表、保存的待办事项清单或看板，以及内部专用的知识库文章来记录它。
我个人更喜欢为事件准备一份清晰的检查清单，这样任何人都能轻松地通览清单，标记出哪些需要更新、哪些不需要，并分配具体的文档更新任务。
客户评价：Baklib 的多站点功能能够在一个位置进行更改并共享这些文档到不同的平台。它帮助我们避免了信息在多个地方，而只有一个来源的单一可信源追踪。
但这里的关键是，当你听说触发事件发生时，你会知道需要检查和更新文档的哪些部分，比如那个组织架构图文件，或者提供产品或部门名称的代码片段。使用 Baklib 构建的企业 Wiki 或知识库，能让你轻松地创建和管理这类清单，确保文档变更流程清晰、可追踪。
制定好这份清单后，请将其纳入您的内容工作流程中，以便持续使用和更新。将其明确记录为文档的一大优势在于，您可以与其他团队和部门共享，从而让他们也知道，在发布错误修复或启动新的营销活动时，需要及时通知您。
通过元数据明确更新目标
拥有触发事件清单后，您可以审核文档，并为其添加与这些事件相关的元数据，从而精确定位需要更新的具体文档。
元数据的价值在于：它是关于文档本身的信息。请评估您的内容创作工具（例如 Baklib）在元数据管理方面提供的功能，并加以充分利用。关键是检查您的工具是否提供了便捷方式，让您能够根据元数据筛选内容并生成报告或列表。
您需要寻找的是一个或多个元数据字段，能够将您的内容与识别出的触发事件关联起来。这样，您就可以明确声明：当 [现实条件 X] 发生时，这份特定的内容就需要更新。 具体的关联方式取决于您所管理的知识类型。
这个元数据字段应该便于通过查询、筛选或导出进行操作。例如：
- 情景：公司HR政策发生变化。
- 操作：您已将“hr-policy”作为元数据标签。
- 结果：您应该能够快速提取所有带有“hr-policy”标签的内容列表。
提示： 您可能需要调整一个现有字段的用途，或进行一些设置以在最终用户界面中隐藏某些元数据字段。请放心调整——这是值得的投资！
建立并融入工作流程
一旦确定了可用的元数据字段，就要确保将其填充和更新工作，固化为每个内容创建、发布或更新流程的必备环节。
当您和您的撰稿人亲身体验到它能带来的效率提升和时间节省后，大家甚至会主动去完善这些字段！
现实应用案例
让我以 Baklib 支持文档的编写为例，展示这一过程的具体应用。
触发事件与受影响元素
作为一家SaaS公司，我们的产品更新主要源于两类事件，它们会自动触发内容更新：
触发事件类型 说明
| 错误修复 | 修正产品问题后，相关说明文档需同步更新。
| 软件版本发布 | 新功能发布或旧功能变更，需要更新或新增文档。
其中，“更新现有功能”是最复杂的触发事件，因为这要求我们找到该功能的现有文档进行修订，而非从零开始创作。
针对此事件，受影响的文档元素可能包括：
- 提及该功能的相关文章或分类。
- 专门介绍该功能的文章或分类。
- 包含功能操作步骤或概览的截图。
- 根据功能影响范围，公司主站和入门指南也可能需要调整。
- 知识库的整体组织结构也可能因此发生变化。
因此，如果我们发布了“订阅”功能的更新，我就知道需要更新文章和类别中的文本和截图，并且根据更新的性质，我可能需要审查更高层级的内容甚至组织结构。
元数据（Metadata）的实践应用
但是，具体哪些文章需要我更新呢？这就是元数据（Metadata）发挥作用的地方！
Baklib是我的创作工具，它有一个称为标签的元数据字段。我可以根据需要向文章或类别添加任意数量的标签。这些标签可以在我们的管理报告中用作筛选器，这是进行内容审计的有效方法。因此，这个字段似乎为我提供了所需的灵活性和报告功能。（其他工具有不同的元数据结构——希望您使用的工具也有类似功能。）
许多人可以将他们的触发事件列表本身用作元数据。但对于我们这样的软件公司来说，基本上每一条内容都涉及软件功能，所以如果我只是添加一个“软件功能更新”的标签，那将毫无意义。
相反，我们为应用程序中的每个屏幕设置了一个标签。我们将该标签添加到包含该屏幕截图或文本引用的每篇文章或类别中。例如，对于订阅，这里引用的元数据是针对订阅设置页面的（内部引用：ref-settings-subscriptions）。这样，如果我们对该页面的布局或功能进行更改，我就知道哪些页面需要更新。
元数据设置与维护
曾经，我们完成了一次大规模的文档审计，审查了知识库中的每一篇文章，并添加了标签，以标识其引用的我们应用程序中的每个页面。（如果您感到不寒而栗，是的，这需要投入时间和精力。但这完全值得！）现在，当我们创建新的和更新现有内容时，我们会确保更新这些内容标签。例如，以下是我们其中一篇文章的标签部分：
Baklib文章中的示例标签字段
只需看一眼这个“标签”字段，我就能知道这篇文章关联了应用中的三个页面：
- 编辑片段界面 (int: ref-edit-snippet)
- 片段库 (int: ref-library-snippets)
- 样式 > 设置，自定义 HTML > 文章界面 (int: ref-html-article)
（同时它已被标记为需要更新截图……因为我们仍在处理审计中发现的问题！）
这种设置的美妙之处在于，任何时候我们做出更改——无论是微小的错误修复还是一个完整的新功能——我都不需要猜测哪些页面需要更新。我可以直接进入Baklib的“管理文章”页面，只需点击几下鼠标，运行一个过滤器，就能得到一个完整的、所有需要更新的文章或类别列表。
举个例子，假设我们更新了Baklib的“片段库”界面。在审计之前的日子里，我很可能只是简单地搜索“snippet”，然后手动审查搜索出来的每一篇文章。
而现在，如果我们做出了更改，我可以轻松地进入Baklib的“管理文章”页面，找到我的列表。
与其花费数小时在你的知识库中费力寻找已更改内容的截图或引用，不如在你的文档流程中添加一个小小的额外元数据（Metadata）步骤。然后，你就可以简单地运行一个查询、筛选或报告，立刻获得一个待处理列表。
更多时间用于创作，更少时间用于查找。
技术写作深度探讨
想了解更多技术写作洞见？
- 欢迎收听 The Not-Boring Tech Writer 播客，在那里我与经验丰富的专业技术写作者探讨技术写作的真实复杂性。
- 在我的单人节目中，我也会分享作为一名技术写作者的真实想法和感悟。
关于 Baklib
Baklib——新一代一体化数字体验管理平台，集成多点解决方案。
让我们将您企业的数字化渠道打造为以数字资产为基础，深化客户体验、员工体验、数据体验的全体验之旅。
