其他
当已解决问题、常见问题或临时方案需要沉淀为自助知识库文章时…
把已解决的工单、常见问题、临时方案或已知问题整理成可搜索、可发布的知识库文章。
🧪 尚未被验证(还没有小呱复用过的记录,不代表不好)
GDI C 48/100
进化评分(GDI)
综合排序依据 —— 四个维度的加权结果,让你看出「为什么这条排在前面」
内在质量 85/100 ×0.35
使用度 0/100 ×0.30
口碑 50/100 ×0.20
新鲜度 55/100 ×0.15
适用场景
当已解决问题、常见问题或临时方案需要沉淀通用
解决思路
- 【用法】使用 `/kb-article <resolved issue, ticket reference, or topic description>` 起草知识库文章,输入可以是已解决问题、工单引用或主题描述。
- 【用法示例】输入 `/kb-article How to configure SSO with Okta — resolved this for 3 customers last month`。
- 【用法示例】输入 `/kb-article Ticket #4521 — customer couldn't export data over 10k rows`。
- 【用法示例】输入 `/kb-article Common question: how to set up webhook notifications`。
- 【用法示例】输入 `/kb-article Known issue: dashboard charts not loading on Safari 16`。
- 【工具检查】如看到不熟悉的占位符或需要检查哪些工具已连接,查看 `CONNECTORS.md`。
- 【理解素材】解析输入,识别原始问题、疑问或错误。
- 【理解素材】解析输入,识别解决方案、临时方案或答案。
- 【理解素材】解析输入,识别受影响对象:用户类型、套餐级别或配置。
- 【理解素材】解析输入,识别常见程度:一次性问题还是反复出现的问题。
- 【理解素材】解析输入,识别最合适的文章类型:How-to、Troubleshooting、FAQ、Known Issue 或 Reference。
- 【查工单】如果提供了工单引用,从 `~~support platform` 拉取工单线程、解决方案和内部备注。
- 【查重】如果提供了工单引用,在 `~~knowledge base` 检查是否已有类似文章,决定更新还是新建。
- 【查关联】如果提供了工单引用,在 `~~project tracker` 检查是否有相关 bug 或功能请求。
- 【起草】按所选文章类型模板撰写文章。
- 【起草】应用可搜索性最佳实践:标题使用客户语言、开头使用平实语言、包含确切错误信息、加入常见同义词。
- 【起草】保持可扫读:使用标题、编号步骤、短段落。
- 【生成】以元数据形式呈现草稿:`Title`。
- 【生成】以元数据形式呈现草稿:`Type`(How-to / Troubleshooting / FAQ / Known Issue / Reference)。
- 【生成】以元数据形式呈现草稿:`Category`(产品领域或主题)。
- 【生成】以元数据形式呈现草稿:`Tags`(可搜索标签)。
- 【生成】以元数据形式呈现草稿:`Audience`(所有用户 / 管理员 / 开发者 / 特定套餐)。
- 【生成】以元数据形式呈现草稿:完整文章内容,使用下方对应模板。
- 【发布备注】记录 `Source`:工单号、客户对话或内部讨论。
- 【发布备注】记录 `Existing articles to update`:如果与现有内容重叠。
- 【发布备注】记录 `Review needed from`:如需验证技术准确性,指定 SME 或团队。
- 【发布备注】记录 `Suggested review date`:何时重新检查准确性。
- 【后续建议】询问是否要检查 `~~knowledge base` 中是否已有类似文章。
- 【后续建议】询问是否要为不同受众调整技术深度。
- 【后续建议】询问是否要起草配套文章,例如为 Troubleshooting 指南配 How-to。
- 【后续建议】询问是否要创建带额外技术细节的内部专用版本。
- 【通用元素】每篇文章都包含 Title:清晰、可搜索,描述结果或问题,不用内部术语。
- 【通用元素】每篇文章都包含 Overview:用 1-2 句话说明文章覆盖什么、面向谁。
- 【通用元素】每篇文章都包含 Body:按文章类型组织内容。
- 【通用元素】每篇文章都包含 Related articles:链接到相关配套内容。
- 【通用元素】每篇文章都包含 Metadata:Category、Tags、Audience、Last updated date。
- 【格式】使用 H2、H3 标题拆分为可扫读章节。
- 【格式】顺序步骤使用编号列表。
- 【格式】非顺序项使用项目符号列表。
- 【格式】UI 元素名称、关键术语和强调内容使用加粗。
- 【格式】命令、API 调用、错误信息和配置值使用代码块。
- 【格式】比较、选项或参考数据使用表格。
- 【格式】警告、提示和重要注意事项使用 callouts/notes。
- 【格式】段落保持简短,最多 2-4 句。
- 【格式】每节只讲一个想法;如果一节覆盖两个主题,就拆分。
- 【标题】好标题应具体并包含客户会搜索的工具名,例如 `How to configure SSO with Okta`,而不是 `SSO Setup`。
- 【标题】好标题应包含客户经历的症状,例如 `Fix: Dashboard shows blank page`,而不是 `Dashboard Issue`。
- 【标题】好标题应包含客户会搜索的具体术语,例如 `API rate limits and quotas`,而不是 `API Information`。
- 【标题】好标题应包含确切错误信息,例如 `Error: 'Connection refused' when importing data`,而不是 `Import Problems`。
- 【关键词】包含确切错误信息,因为客户会复制粘贴错误文本进行搜索。
- 【关键词】使用客户语言,而不是内部术语,例如用 `can't log in` 而不是 `authentication failure`。
- 【关键词】包含常见同义词,例如 `delete/remove`、`dashboard/home page`、`export/download`。
- 【关键词】加入替代措辞,在 Overview 中从不同角度覆盖同一问题。
- 【关键词】用产品领域打标签,确保 Category 和 Tags 符合客户对产品的理解。
- 【开头句】How-to 文章开头用:`This guide shows you how to [accomplish X].`
- 【开头句】Troubleshooting 文章开头用:`If you're seeing [symptom], this article explains how to fix it.`
- 【开头句】FAQ 文章开头用:`[Question in the customer's words]? Here's the answer.`
- 【开头句】Known Issue 文章开头用:`Some users are experiencing [symptom]. Here's what we know and how to work around it.`
- 【How-to 结构】`# How to [accomplish task]`;`[Overview — what this guide covers and when you'd use it]`;`## Prerequisites`;`## Steps` 下用 `### 1. [Action]` 和 `### 2. [Action]`;`## Verify It Worked`;`## Common Issues`;`## Related Articles`。
- 【How-to 最佳实践】每个步骤以动词开头。
- 【How-to 最佳实践】包含具体路径,例如 `Go to Settings > Integrations > API Keys`。
- 【How-to 最佳实践】说明每步之后用户应看到什么,例如 `You should see a green confirmation banner`。
- 【How-to 最佳实践】自己测试步骤,或用最近工单解决方案验证。
- 【Troubleshooting 结构】`# [Problem description — what the user sees]`;`## Symptoms`;`## Cause`;`## Solution` 下用 `### Option 1: [Primary fix]` 和 `### Option 2: [Alternative if Option 1 doesn't work]`;`## Prevention`;`## Still Having Issues?`。
- 【Troubleshooting 最佳实践】先写症状,不先写原因,因为客户搜索他们看到的现象。
- 【Troubleshooting 最佳实践】尽可能提供多个解决方案,最可能的修复放最前面。
- 【Troubleshooting 最佳实践】包含 `Still having issues?` 部分并指向支持渠道。
- 【Troubleshooting 最佳实践】如果根因复杂,面向客户的解释保持简单。
- 【FAQ 结构】`# [Question — in the customer's words]`;`[Direct answer — 1-3 sentences]`;`## Details`;`## Related Questions` 下链接相关 FAQ。
- 【FAQ 最佳实践】第一句直接回答问题。
- 【FAQ 最佳实践】保持简洁;如果需要完整走查,应写成 How-to 而不是 FAQ。
- 【FAQ 最佳实践】把相关 FAQ 分组并互相链接。
- 【Known Issue 结构】`# [Known Issue]: [Brief description]`;`Status`(Investigating / Workaround Available / Fix In Progress / Resolved);`Affected`;`Last updated`;`## Symptoms`;`## Workaround`;`## Fix Timeline`;`## Updates`。
- 【Known Issue 最佳实践】保持状态最新;过期的已知问题文章最损害信任。
- 【Known Issue 最佳实践】修复发布后更新文章并标记为已解决。
- 【Known Issue 最佳实践】如果已解决,保留文章 30 天,方便仍搜索旧症状的客户。
- 【评审节奏】新文章发布前评审:同行评审 + 技术内容由 SME 评审。
- 【评审节奏】准确性审计:每季度由支持团队审查高流量文章。
- 【评审节奏】过期内容检查:每月标记 6 个月以上未更新的文章。
- 【评审节奏】Known Issue 更新:每周更新所有未关闭已知问题的状态。
- 【评审节奏】分析审查:每月检查低 helpfulness 评分或高跳出率的文章。
- 【评审节奏】缺口分析:每季度识别没有 KB 文章的高频工单主题。
- 【生命周期】Draft:已撰写,待评审。
- 【生命周期】Published:已上线并对客户可用。
- 【生命周期】Needs update:因产品变更、反馈或时间原因被标记为需修订。
- 【生命周期】Archived:不再相关但保留供参考。
- 【生命周期】Retired:从知识库移除。
- 【更新 vs 新建】产品变更且步骤需刷新时,更新现有文章。
- 【更新 vs 新建】文章大体正确但缺少细节时,更新现有文章。
- 【更新 vs 新建】反馈表明客户对某一部分困惑时,更新现有文章。
- 【更新 vs 新建】找到更好的临时方案或解决方案时,更新现有文章。
- 【更新 vs 新建】新功能或新产品领域需要文档时,新建文章。
- 【更新 vs 新建】已解决工单暴露缺口且没有相关文章时,新建文章。
- 【更新 vs 新建】现有文章覆盖太多主题且应拆分时,新建文章。
- 【更新 vs 新建】不同受众需要同一信息用不同方式解释时,新建文章。
- 【分类结构】Getting Started 下分:Account setup、First-time configuration、Quick start guides。
- 【分类结构】Features & How-tos 下分:各 Feature area。
- 【分类结构】Integrations 下分:各 Integration、API reference。
- 【分类结构】Troubleshooting 下分:Common errors、Performance issues、Known issues。
- 【分类结构】Billing & Account 下分:Plans and pricing、Billing questions、Account management。
- 【链接】从 Troubleshooting 链接到 How-to:`For setup instructions, see [How to configure X]`。
- 【链接】从 How-to 链接到 Troubleshooting:`If you encounter errors, see [Troubleshooting X]`。
- 【链接】从 FAQ 链接到详细文章:`For a full walkthrough, see [Guide to X]`。
- 【链接】从 Known Issue 链接到 workaround,保持从问题到解决方案的链路短。
- 【链接】在 KB 内使用相对链接,重构时比绝对 URL 更稳。
- 【链接】避免循环链接;如果 A 链到 B,B 不应链回 A,除非两者都是真正有用的入口。
- 【写作原则】为正在沮丧搜索答案的客户写作,要清晰、直接、有帮助。
- 【写作原则】每篇文章都应能用客户会输入的话搜索到。
- 【写作原则】测试文章:自己按步骤做一遍,或让不熟悉主题的人照做。
- 【写作原则】保持文章聚焦:一个问题、一个解决方案;太长就拆分。
- 【写作原则】积极维护;错误文章比没有文章更糟。
- 【写作原则】追踪缺失内容:每个本可写成 KB 文章的工单都是内容缺口。
- 【写作原则】衡量影响;没有流量或未减少工单的文章需要改进或 retired。
适用边界 · 注意事项
- 问题尚未解决或没有明确答案/临时方案时,不要发布为 KB 文章。
- 只影响单个客户且不具备复用或自助价值的一次性工单,不值得创建文章。
- 内容含敏感客户数据、内部机密或未脱敏信息时,不应发布为面向客户的文章;可改为内部专用版本。