PDF 指南与在线知识库文章对比

分步指南可以作为 PDF 文件发布，也可以作为在线知识库中的文章发布。两种形式可以包含相同的步骤和截图。二者的区别在于读者如何找到内容、作者如何更新内容，以及由谁控制副本。

本文对两者进行比较，并说明如何从 Mac 上的一个 Temposhot Document 生成任一形式。

示例是一份 25 步的发票产品入门指南，内容为连接银行账户并导入第一份对账单。自助服务客户在帮助中心阅读该指南。企业客户在入门资料包中收到 PDF，其 IT 团队会将其打印出来用于内部审批。

PDF 与知识库对比概览

项目	PDF 指南	在线知识库文章
分发方式	以文件发送：邮件、云盘、附件	发布在 URL 上
更新	生成新文件；旧副本仍在流通	编辑一次，读者即可看到变更
搜索	在文件内搜索；取决于 PDF 的制作方式	站内搜索和网络搜索引擎
访问控制	持有文件的人均可阅读；可选密码	平台权限和登录
离线使用	下载后可离线使用	需要网络连接，除非平台缓存
打印	版式固定，按设计打印	取决于网站的打印样式
版本记录	每个文件是固定快照	取决于平台的修订历史
所有权	收件人持有副本	发布方控制唯一副本

一般而言，两者没有优劣之分。合适的选择取决于谁阅读指南，以及指南更新的频率。

哪些行对入门指南最关键

对于自助服务客户，决定因素是搜索和更新。他们会在帮助中心输入“connect bank”，并期望步骤与当前界面一致。对于企业客户，决定因素是版本记录和打印，因为其审批流程需要将固定副本附在工单上。

因此，这 25 个步骤需要同时提供两种格式。本文其余部分说明如何防止两者内容不一致。

适合使用 PDF 的固定说明

当读者需要一份不会变化的副本时，适合使用 PDF：

• 客户交付和合同： 指南是交付资料包的一部分。
• 受监管的流程： SOP 版本附在记录中，必须保持已批准的状态。
• 离线和现场工作： 读者没有可靠的网络连接。
• 培训和打印： 参与者需要在打印件上做批注。
• 一次性解答： 通过支持回复引导单个客户完成一次修复。

PDF 也适用于不在贵方系统内的读者，例如无法登录贵方知识库的客户团队。

企业版 PDF 的导出设置

Temposhot 的 Export PDF 对话框在设置旁显示实时预览。默认值为 A4、横向、开启封面页、开启步骤编号、开启页码、说明位于图片之前、图片尺寸为“Fit without enlarging”，画质为 High quality。修改这些设置需要 Temposhot Pro。

对话框底部的页脚会汇总当前选择，例如“25 steps · Letter · Landscape”。点击 Reset 可将所有设置恢复为默认值。

封面页和步骤编号的作用

企业 IT 团队会打印指南，并在设置过程中标记每个已完成的步骤。步骤编号为提问提供参照，例如“第 14 步显示的银行列表不同”。页脚中的页码显示当前页和总页数，因此打印件缺页时可以直接发现。

封面页在第一张截图之前列出指南名称和步骤数。将版本号写入 Document 标题后，封面同时可作为审批工单所需的版本记录。

说明位于图片之前或之后

Descriptions 提供三个选项：Before image、After image 和 Hidden。Before image 适合操作说明，因为读者先了解要做什么，再看到操作位置。After image 适合说明结果，例如“对账单现在显示 42 笔交易”。

入门指南使用 Before image。Hidden 适合已熟悉操作的读者使用的快速视觉参考。

25 张截图的纸张尺寸和方向

横向可以在不缩小文字的情况下容纳较宽的浏览器截图。纵向为长篇说明留出更多空间，但会将较宽的截图缩小到页面宽度。入门指南中的大部分界面是完整的浏览器窗口，因此保留了横向。

由紧凑取景页面组成的指南，例如围绕小型控件使用 Close 或 Tight 取景，适合纵向。这类截图的宽度较窄，纵向时不会被缩小。

小截图与大截图的图片尺寸

Image size 有两个选项。Fit without enlarging 使小截图保持原始尺寸，因此紧凑取景的按钮不会被放大成模糊的色块。Fit to page 将每张截图缩放到页面尺寸，使小裁剪图填满页面，但可能导致图像变软。

入门指南同时包含完整窗口页面和少量 Close 取景页面，因此保留默认值 Fit without enlarging。

适合使用在线文章的当前指南

当指南需要长期对大量读者保持正确时，适合使用在线文章：

• 产品帮助： 步骤随发布变化，读者期望看到当前版本。
• 自助服务支持： 客户在提交工单前先进行搜索。
• 内部操作指南： 团队在聊天和工单中链接到同一个来源。
• 交叉链接较多的指南： 文章之间相互链接；PDF 向外链接并不方便。

如果平台提供分析功能，在线文章还可以显示读者的阅读页面。

围绕图片撰写文章正文

知识库文章不是 25 张图片的简单排列。读者通常先浏览正文，只在不确定时才查看截图。每个步骤都需要在文章中提供简短的操作说明，并在其下方放置图片。

为每张图片填写替代文本，说明界面内容，例如“带有 Add account 按钮的银行账户页面”。图片文件名即页面标题，可以作为起点，但不足以完整描述图片内容。

知识库完全适用的情况

有些指南不应制作为 PDF。如果步骤每次发布都会变化，通过邮件发送的 PDF 几周内就会过时。如果读者通过搜索引擎或产品内的链接进入，下载 PDF 需要额外操作，很多人不会去做。

入门指南是例外，因为企业客户需要固定副本。“修复失败的银行同步”这类指南仅保留为文章。

利用读者数据查找薄弱步骤

带有分析功能的知识库可以显示读者在哪一步离开文章，以及哪些搜索词引导读者进入文章。对于入门指南，大量搜索“bank not listed”的记录指向第 10 步，即显示银行列表的步骤。据此，团队新增了一段关于按银行代码搜索的说明。

PDF 无法提供此类信号。引用步骤编号的支持工单是最接近的替代，这也是保留步骤编号的另一个原因。

按顺序上传截图

PNG 和 WebP 页面以页面标题命名。“Open Settings”和“Select Bank accounts”这类标题按字母顺序排序，而非按步骤顺序。大多数知识库编辑器按插入顺序排列图片，因此应按照 Document 的页面顺序插入。

为每个标题添加步骤编号，例如“07 Select Bank accounts”，可使文件保持有序。该编号还会出现在 PDF 标题中，与 PDF 自动添加的步骤标签相邻，因此每份指南只选择一种方式。

比较更新责任

对于 PDF，发布较容易，更新较困难。已发送的每个副本都保持原样。需要掌握副本的存放位置并予以替换，否则旧版本会继续流通。应在封面上标明版本和日期，便于读者区分。

对于在线文章，更新较容易，但仍需要有人负责。过时截图的知识库与过时的 PDF 同样具有误导性，而且读者会因为内容在线上而认为它是最新的。无论采用哪种形式，都应指定负责人。关于日常维护流程，请参阅保持截图文档更新。

记录每份 PDF 的接收方

已通过邮件发送的 PDF 无法撤回。应保留一份简短的企业联系人列表，记录每位联系人收到的版本和日期。发布 v2.3 后，该列表可以准确显示仍持有 v2.2 的人员。

入门指南的联系人列表共有 14 人。向全部联系人发送 v2.3，并附上 3 个变更步骤的一行摘要，所需时间少于处理过时副本可能引发的支持工单。

指定一位两种格式的负责人

如果按格式划分负责人，例如支持团队负责文章、销售团队负责 PDF，两份副本就会逐渐不一致。由同一位负责人管理 Document，可确保所有导出内容来自同一来源。在本示例中，入门产品经理负责 Document 及两种导出格式。

为 PDF 文件名加入版本号

封面以文档标题和步骤数开头。将版本号写入 Document 标题，版本号即出现在封面上。将版本号写入文件名，则可以按版本对交付文件夹进行排序。

如果导出路径中已存在同名文件，Temposhot 会在新文件名后添加编号，而不会覆盖原文件。在文件名中更新版本号，可避免出现 connect-bank-account 2.pdf 这类无法体现内容的文件名。

一次发布，同时更新两种格式

产品每年发布 4 次。上一次发布中，银行列表页面新增了搜索框，共影响 25 个步骤中的 3 个。每次更新都按相同顺序进行。

比较访问权限与分发

PDF 一经发送即可自由流转。如需限制访问，浏览器工具 Protect PDF 可在本地添加 AES-256 密码，但持有密码的人仍可转发文件。包含大量截图的大型 PDF 可能超过邮件大小限制，此时可使用 Compress PDF 减小文件大小。

知识库文章继承平台的访问规则：公开、需登录的客户或内部员工。撤销访问权限对之后的访问有效，但读者可能已经保存或打印了副本。

企业 IT 团队的访问

企业客户通常无法在企业网络中登录供应商的帮助中心，其 IT 人员也可能没有客户账户。PDF 无需账户即可送达。这是入门指南同时提供两种格式的主要原因。

PDF 设置密码可以限制随意转发，但无法阻止有意的读者。对于本指南这类不含机密数据的内容，密码的作用主要是增加操作步骤。如果指南包含内部设置或账户信息，则应设置密码。

将 PDF 控制在可通过邮件发送的大小

25 张完整窗口截图若使用 High quality，会生成很大的文件。应先尝试在 Image quality 下选择 Balanced 或 Small file，并在预览中检查文字是否清晰可读。如果文件仍超过邮件系统的限制，可使用 Compress PDF 以较低分辨率重新渲染页面。

压缩会降低截图的清晰度。发送前，应以 100% 比例打开压缩后的文件，检查内容复杂页面中最小的标签是否清晰可读。

PDF 指南的分发规则

以单一来源同时使用两种形式

许多团队在线发布内容，同时提供 PDF 以供离线或正式使用。风险在于两份副本逐渐不一致。应保留一个可编辑的来源，并从该来源导出两种格式。

在 Temposhot 中，该来源即为 Document：

1. 一次性制作指南

   使用 Action Capture（Command+3）录制操作，或导入图片，然后在 Documents 编辑器中修改标题、说明、取景和标注。

2. 为知识库导出图片

   打开 More export formats，选择 PNG 或 WebP 页面。按页面顺序将图片上传到文章中。文件名与页面标题一致。

3. 导出 PDF

   选择 Export PDF。使用 Pro 版本时，可添加封面页、步骤编号和页码，并设置说明位于每张截图之前或之后。

4. 每次修改后重新导出

   编辑 Document，然后重新导出两种格式，并替换已发布的副本。

More export formats 导出的 ZIP 包包含渲染后的 PNG 页面和 document.json。如果需要通过脚本将内容导入文档系统，该文件会有所帮助。Documents 导出指南列出了所有格式。

使用 ZIP 包进行脚本导入

拥有文档流水线的团队可以通过脚本导入指南，无需手动上传 25 张图片。ZIP 包包含渲染后的 PNG 页面和 document.json 文件。脚本可以读取该包，并通过知识库自身的导入功能或 API 创建文章。

应先在一个简短的 Document 上测试脚本，检查知识库中的页面顺序和图片名称是否与 Document 一致。

说明的存放位置

PDF 中的页面说明会根据 Descriptions 的设置显示在每张截图之前、之后，或不显示。PNG 页面仅包含图片，因此说明文字必须保存在文章中。应从 Page Inspector 复制每段说明，并将其放在对应图片下方的文章中；或者将文章正文作为主版本，在编辑后粘贴回 Document。

应选定一个方向并保持不变。在本示例中，Document 是主版本，因为企业客户确认的是 PDF 版本。

按以下规则选择

请回答两个问题：

1. 未来几个月内步骤是否会变化？ 如果会，应先在线发布。
2. 读者是否需要保存一份固定副本？ 如果需要，还应导出 PDF，并在封面上标注版本和日期。

如果两个问题的答案都是否定的，两种形式均可，选择读者已经在使用的格式即可。如果两个答案都是肯定的，应在线发布，并附上带日期的 PDF。

将规则应用于三类指南

“连接银行账户”会随部分发布而变化，企业读者需要固定副本，两个问题的答案均为是，因此先在线发布，并附带带日期的 PDF。“修复失败的银行同步”经常变化，且无需保存副本，因此仅在线发布。“年终导出清单”每年变化一次，会计师需要打印，因此先提供 PDF，并附上一篇指向该文件的简短文章。

判断规则每份指南只需一分钟。将结论记录在指南索引中，可避免每次发布时重复判断。

发送前检查 PDF

常见问题

PDF 指南可以搜索吗？

标题和说明中的文字可以搜索，具体取决于 PDF 的制作方式。截图内的文字无法搜索，除非 PDF 经过 OCR 处理。参阅可搜索 PDF。

可以将 PDF 指南放入知识库吗？

可以，作为附件添加。但读者会遇到 PDF 的限制：需要下载文件，而不是在页面上阅读，站内搜索也可能无法索引该文件。

哪种形式对 SEO 更有利？

在线文章更有利，因为搜索引擎会索引页面及其文字。PDF 也可以被索引，但通常不是效果较好的着陆页。

PDF 应使用 A4 还是 Letter？

使用读者打印时所用的纸张尺寸。Letter 是美国和加拿大的标准，大多数其他国家使用 A4。Temposhot 的默认值为 A4。

能否让 PDF 中的截图可搜索？

Document 的 PDF 导出会渲染包含标题和说明的页面。若要从截图本身获取文字层，可从结果面板或 Capture History 将帧导出为 capture PDF（该功能会运行 OCR），或使用浏览器工具 Screenshot to Searchable PDF。

如何告知读者存在更新的版本？

在 Document 首页的页面说明中提及在线文章。持有旧 PDF 的读者即可知道当前步骤的位置。

能否打印知识库文章来替代导出 PDF？

可以，通过浏览器的打印对话框。结果取决于网站的打印样式，截图可能被分割到不同页面。导出的 PDF 则每页包含一个步骤，标题和说明采用固定版式。

Document 导出会更新已发布的文件吗？

不会。更改页面顺序、取景或标注不会影响已导出的文件。每次编辑后应重新导出，然后替换帮助中心的图片并发送新的 PDF。

将点击操作转化为清晰的分步指南

Action Capture 会生成一个 Document，可导出为 PDF 和知识库图片。下载 Temposhot，或参阅在 Mac 上将截图保存为 PDF。