知识库条目
一个条目讲清一个主题:结论、场景、步骤、示例与常见问题。
可整段复制 占位符用双大括号标出,替换成你的内容即可
# 知识库条目|{{主题}}
## 一、一句话结论
{{用一句话说清这个主题最重要的结论}}
## 二、适用场景
- 什么时候用:{{场景}}
- 什么时候不用:{{边界}}
## 三、核心内容
### 要点一:{{标题}}
{{解释}}
### 要点二:{{标题}}
{{解释}}
### 要点三:{{标题}}
{{解释}}
## 四、操作步骤
1. {{第一步}}
2. {{第二步}}
3. {{第三步}}
## 五、示例
- 输入:{{例子}}
- 处理:{{做法}}
- 输出:{{结果}}
## 六、常见问题
| 问题 | 原因 | 处理 |
| --- | --- | --- |
| {{问题一}} | {{原因}} | {{处理}} |
| {{问题二}} | {{原因}} | {{处理}} |
## 七、相关信息
- 负责人:{{姓名}}
- 相关文档:{{链接}}
- 最后更新:{{日期}}
- 下次复核:{{日期}}
复制与下载都在浏览器本地完成,不会上传内容,也不需要登录。
怎么用
- 标题用「主题 + 结论」的形式,方便以后搜索时一眼判断是否相关。
- 写清适用与不适用边界,避免后来者生搬硬套。
- 指定负责人与复核时间,知识库才不会变成过期文档堆。
为什么这么写
- 结论先行让读者三秒内知道这条内容是否解决自己的问题。
- 步骤与示例结合,比只写概念更容易被直接复用。
- 常见问题来自真实咨询,是知识库最有价值的部分。
- 复核时间能提醒维护者定期检查是否仍然有效。
常见错误
- 标题只写主题,不写结论,搜索时无法判断。
- 大段复制外部资料,没有结合本团队实际。
- 没有负责人,内容过时也没人更新。