创建并发布一篇 Knowledge 文章
Knowledge 文章是用于政策、说明以及其他非目录信息的维护型文档。当前编辑器支持标题、摘要、富文本正文、标题、列表、链接、图片、视频、表格、分隔线、按钮、对齐以及其他格式设置。 本指南涵盖内容生命周期,从来源归属到 Public 或 Private,以及 Published 或 Draft 状态。它还说明了为什么在已更改的文章出现在新的不可变公开快照中之前,需要重新发布 Helpdesk。 这如何融入 Humind Know...
Knowledge 文章是用于政策、说明以及其他非目录信息的维护型文档。当前编辑器支持标题、摘要、富文本正文、标题、列表、链接、图片、视频、表格、分隔线、按钮、对齐以及其他格式设置。
本指南涵盖内容生命周期,从来源归属到 Public 或 Private,以及 Published 或 Draft 状态。它还说明了为什么在已更改的文章出现在新的不可变公开快照中之前,需要重新发布 Helpdesk。
这如何融入 Humind
Knowledge 是 Humind 使用的非目录信息的维护来源。文章、片段、导入的网页、文档以及外部帮助中心来源具有不同的归属和可见性规则。请选择与信息维护方式相匹配的来源类型。
公开且已发布的文章也可以投射到 Helpdesk 中。片段仍然是操作指导,而不是公开的 Helpdesk 页面。为每项政策保留一个权威来源,可以减少相互冲突的回答,并使更新可审计。
开始之前
访问权限:创建、编辑、发布、取消发布、移动或删除文章需要具有 Knowledge 写入权限。发布 Helpdesk 需要相应的 Helpdesk 管理权限。
- 确定该政策或主题的权威负责人。
- 搜索现有的 Knowledge 来源,以防止权威来源重复。
- 在编写之前,选择文件夹、受众、审核日期和目标 Helpdesk 区域设置。
分步工作流程
在正确的文件夹中创建文章
打开 AI Agent、Knowledge,导航到目标文件夹,选择新建内容,然后选择文章。使用具体任务或问题作为标题,并编写一个摘要,准确告诉读者该指南能帮助他们完成什么。
如果该主题不是公开文档,请重新考虑私有文章、片段、网页或文档是否是更好的来源。
为便于快速浏览和执行而写作
先写结果,然后补充前提条件、编号步骤、权限要求或注意事项、验证、故障排除以及相关链接。使用标题和列表来组织结构。只有在能减少歧义时才添加表格或媒体。
记录产品时,请使用 Humind 当前的准确标签。不要包含私有 id、内部端点、凭据、推测性功能,或会立即过时的截图。
设置可见性和生命周期
打开 Knowledge 设置面板,选择 Public 或 Private,然后选择 Published 或 Draft。Public 控制受众;Published 控制条目是否处于活动状态。公开草稿尚未准备好用于在线 Helpdesk。
确认公司使用的任何活动期或 Helpdesk 适用资格设置。在审核者仍在处理事实或法律问题时,请将该条目保持为草稿。
审核并测试来源
请主题负责人和编辑审核事实、步骤、链接、语言和无障碍性。然后在 Playground 中测试有代表性的问题,以查看 Agent 是否能正确应用该文章,并且不会与其他来源冲突。
应修正文章或冲突来源,而不是测试提示。发布状态或内容发生变化后,请开始一次新的对话。
在需要时发布新的 Helpdesk 版本
如果该文章属于公开 Helpdesk,请检查 Helpdesk 内容投射、集合、标题、摘要和区域设置。仅当完整的已选集合保持一致时,才发布新的不可变 Helpdesk 版本。
先前的 Helpdesk 版本仍然是不可变的历史快照。不要期望编辑 Knowledge 会追溯性地重写较早的发布版本。
权限和重要注意事项
- Public 和 Published 是相互独立的设置,两者都会影响客户可用性。
- 删除文章是破坏性操作,如果审核或历史记录很重要,请先取消发布。
- 富格式应当服务于理解和无障碍性,而不是装饰。
- Helpdesk 发布会对文章内容进行快照,因此之后对 Knowledge 的更改需要再次发布。
验证结果
在认为工作完成之前,请使用此检查清单:
- 标题和摘要准确描述了结果和受众。
- 正文在相关情况下包含步骤、注意事项、验证、故障排除以及有效的内部链接。
- 可见性、发布状态、活动期、文件夹和 Helpdesk 适用资格都是有意设置的。
- 最新的 Helpdesk 快照在正确的区域设置和集合中包含已审核版本。
故障排除
文章已保存,但未公开
检查 Public 或 Private、Published 或 Draft、活动期、Helpdesk 适用资格、投射选择和区域设置。在所有条件都正确后,发布新的 Helpdesk 版本。
Agent 忽略了该文章
确认它已在当前公司中保存并处于活动状态,移除冲突的 Knowledge,使用 Playground 中的全新对话,并提出一个确实符合该文章范围的问题。
内部链接已损坏
使用稳定的 Helpdesk 文章路由,以及同一区域设置下现有的已发布 slug。不要链接到草稿、私有条目、编辑器 URL 或数据库 id。