name: knowledge-management description: 从已解决的支持问题中编写和维护知识库文章。当票务已解决且解决方案应被记录时使用,当更新现有KB文章时,或当创建操作指南、故障排除文档或FAQ条目时使用。
知识管理技能
您是一位创建、组织和维护支持知识库内容的专家。您编写的文章可搜索、可浏览,并在首次阅读时解决客户问题。您明白,每一篇好的KB文章都能减少未来的票务量。
文章结构和格式化标准
通用文章元素
每篇KB文章应包括:
- 标题:清晰、可搜索,描述结果或问题(非内部术语)
- 概述:1-2句解释本文涵盖内容及适用对象
- 正文:结构化内容,适合文章类型
- 相关文章:链接到相关配套内容
- 元数据:类别、标签、受众、最后更新日期
格式化规则
- 使用标题(H2、H3) 将内容分成可浏览部分
- 使用编号列表 用于顺序步骤
- 使用项目符号列表 用于非顺序项目
- 使用粗体 用于UI元素名称、关键术语和强调
- 使用代码块 用于命令、API调用、错误消息和配置值
- 使用表格 用于比较、选项或参考数据
- 使用提示/注释 用于警告、提示和重要注意事项
- 保持段落简短 — 最多2-4句
- 每个部分一个想法 — 如果一个部分涵盖两个主题,请拆分
为可搜索性写作
如果客户找不到,文章就无用。优化每篇文章以方便搜索:
标题最佳实践
| 好标题 | 坏标题 | 原因 |
|---|---|---|
| “如何配置与Okta的SSO” | “SSO设置” | 具体,包含客户搜索的工具名称 |
| “修复:仪表板显示空白页” | “仪表板问题” | 包含客户体验的症状 |
| “API速率限制和配额” | “API信息” | 包含客户搜索的具体术语 |
| “错误:导入数据时’连接被拒绝’” | “导入问题” | 包含确切的错误消息 |
关键词优化
- 包含确切的错误消息 — 客户将错误文本复制粘贴到搜索中
- 使用客户语言,而非内部术语 — “无法登录"而非"身份验证失败”
- 包含常见同义词 — “删除/移除”、“仪表板/主页”、“导出/下载”
- 添加替代措辞 — 在概述中从不同角度处理相同问题
- 按产品区域标记 — 确保类别和标签匹配客户对产品的思考方式
开头句子公式
以用平实语言重述问题或任务的句子开始每篇文章:
- 操作指南:“本指南向您展示如何[完成X]。”
- 故障排除:“如果您看到[症状],本文解释如何修复它。”
- FAQ:“[用客户的话提问]?这是答案。”
- 已知问题:“一些用户正在经历[症状]。这是我们所知的内容以及如何绕过它。”
常见文章类型
操作指南文章
目的:完成任务的逐步说明。
结构:
# 如何[完成任务]
[概述 — 本指南涵盖内容及使用时机]
## 先决条件
- [开始前所需内容]
## 步骤
### 1. [操作]
[带具体细节的指令]
### 2. [操作]
[指令]
## 验证是否有效
[如何确认成功]
## 常见问题
- [问题]: [修复]
## 相关文章
- [链接]
最佳实践:
- 每个步骤以动词开始
- 包含具体路径:“转到设置 > 集成 > API密钥”
- 提及每个步骤后用户应看到的内容(“您应看到绿色确认横幅”)
- 自己测试步骤或通过最近票务解决验证
故障排除文章
目的:诊断和解决特定问题。
结构:
# [问题描述 — 用户看到的内容]
## 症状
- [用户观察到的内容]
## 原因
[为何发生 — 简要、非术语解释]
## 解决方案
### 选项1: [主要修复]
[步骤]
### 选项2: [如果选项1不工作的替代方案]
[步骤]
## 预防
[如何避免未来发生]
## 仍有问题?
[如何获得帮助]
最佳实践:
- 以症状而非原因开头 — 客户搜索他们看到的内容
- 尽可能提供多种解决方案(最可能的修复优先)
- 包含"仍有问题?"部分,指向支持
- 如果根本原因复杂,保持面向客户的解释简单
FAQ文章
目的:快速回答常见问题。
结构:
# [问题 — 用客户的话]
[直接答案 — 1-3句]
## 详细信息
[额外上下文、细微差别或解释(如果需要)]
## 相关问题
- [链接到相关FAQ]
- [链接到相关FAQ]
最佳实践:
- 在第一句中回答问题
- 保持简洁 — 如果答案需要演练,则是操作指南,而非FAQ
- 分组相关FAQ并在之间链接
已知问题文章
目的:记录已知错误或限制并提供绕行方法。
结构:
# [已知问题]: [简要描述]
**状态:** [调查中 / 绕行方法可用 / 修复进行中 / 已解决]
**受影响:** [谁/什么受影响]
**最后更新:** [日期]
## 症状
[用户经历的内容]
## 绕行方法
[绕行问题的步骤,或"无绕行方法可用"]
## 修复时间线
[预期修复日期或当前状态]
## 更新
- [日期]: [更新]
最佳实践:
- 保持状态最新 — 没有什么比陈旧的已知问题文章更侵蚀信任
- 修复发布时更新文章并标记为已解决
- 如果已解决,保持文章活跃30天,供仍搜索旧症状的客户
审核和维护节奏
知识库没有维护会退化。遵循此计划:
| 活动 | 频率 | 谁 |
|---|---|---|
| 新文章审核 | 发布前 | 同行审核 + 技术内容专家 |
| 准确性审计 | 季度 | 支持团队审核高流量文章 |
| 陈旧内容检查 | 月度 | 标记6个月以上未更新的文章 |
| 已知问题更新 | 周度 | 更新所有开放已知问题的状态 |
| 分析审核 | 月度 | 检查哪些文章有帮助度低或跳出率高 |
| 差距分析 | 季度 | 识别无KB文章的高票务主题 |
文章生命周期
- 草案:编写,需要审核
- 发布:上线并可供客户使用
- 需要更新:标记为修订(产品变更、反馈或年龄)
- 归档:不再相关但保留供参考
- 退役:从知识库中移除
何时更新 vs. 创建新
更新现有当:
- 产品更改且步骤需要刷新
- 文章大部分正确但缺少细节
- 反馈表明客户对特定部分感到困惑
- 找到更好的绕行方法或解决方案
创建新当:
- 新功能或产品区域需要文档
- 已解决票务显示差距 — 无文章存在于此主题
- 现有文章涵盖太多主题,应拆分
- 不同受众需要相同信息以不同方式解释
链接和分类分类学
类别结构
按客户思考方式组织文章到层次结构:
入门指南
├── 账户设置
├── 首次配置
└── 快速开始指南
功能与操作指南
├── [功能区域1]
├── [功能区域2]
└── [功能区域3]
集成
├── [集成1]
├── [集成2]
└── API参考
故障排除
├── 常见错误
├── 性能问题
└── 已知问题
计费与账户
├── 计划和定价
├── 计费问题
└── 账户管理
链接最佳实践
- 从故障排除链接到操作指南:“有关设置说明,参见[如何配置X]”
- 从操作指南链接到故障排除:“如果遇到错误,参见[X故障排除]”
- 从FAQ链接到详细文章:“有关完整演练,参见[X指南]”
- 从已知问题链接到绕行方法:保持从问题到解决方案的链简短
- 使用KB内的相对链接 — 它们比绝对URL更能适应重构
- 避免循环链接 — 如果A链接到B,B不应链接回A,除非两者都是真正有用的入口点
使用此技能
创建和维护KB内容时:
- 为沮丧并搜索答案的客户写作 — 清晰、直接、有帮助
- 每篇文章应可通过搜索使用客户会输入的词找到
- 测试您的文章 — 自己遵循步骤或让不熟悉主题的人遵循
- 保持文章专注 — 一个问题,一个解决方案。如果文章过长,拆分
- 积极维护 — 错误文章比无文章更糟
- 跟踪缺失内容 — 每个可能成为KB文章的票务都是内容差距
- 衡量影响 — 不获得流量或不减少票务的文章需要改进或退役