name: support-knowledge-management description: 从已解决的支持问题中编写和维护知识库文章。创建可搜索、可扫描的操作指南和故障排除文档。
支持知识管理
创建、组织并维护支持知识库内容。编写文章,使其可搜索、可扫描,并在首次阅读时解决客户问题。
文章结构
通用元素
- 标题:清晰、可搜索,描述结果或问题(非内部术语)。
- 概述:1-2句解释本文涵盖内容。
- 正文:结构化内容(步骤、列表、代码块)。
- 元数据:类别、标签、受众。
格式化规则
- 使用 H2/H3标题 来分段内容。
- 使用 编号列表 用于步骤。
- 使用 项目符号列表 用于选项/项目。
- 使用 粗体 用于UI元素和关键词。
- 使用 代码块 用于命令/错误。
- 保持段落简短(2-4句)。
常见文章类型
操作指南文章模板
# 如何 [完成任务]
[概述 — 本文指南涵盖内容及何时使用]
## 前提条件
- [开始前需要什么]
## 步骤
### 1. [操作]
[具体细节说明]
### 2. [操作]
[说明]
## 验证是否成功
[如何确认成功]
## 常见问题
- [问题]: [解决方案]
故障排除文章模板
# 修复: [症状或错误消息]
## 症状
[描述用户所见]
## 原因
[解释为何发生]
## 解决方案
1. [步骤1]
2. [步骤2]
## 预防
[如何避免未来发生]
搜索优化
- 在文本中包含确切错误消息。
- 使用客户语言,而非仅内部术语。
- 添加同义词(例如,“删除”和“移除”)。
- 以总结开始,重申问题。