知识沉淀结构化文档文档设计
Claude Code 知识沉淀:创建可复用结构化文档
如何把你的工作经验写成 AI 能够读懂和使用的结构化文档?本文教你设计知识文档的格式,让 AI 调用时效果更好。
· 阅读约 5 分钟
知道要建立知识库之后,很多人遇到的第一个问题是:怎么写?写成什么格式?
这一节教你创建 AI 能够高效读取和使用的结构化知识文档。
让 AI 能读懂的文档格式:Markdown
Markdown 是最适合知识库的格式,因为:
- 结构清晰(标题、列表、表格层次分明)
- AI 能很好地理解和处理
- 在 Trae 里原生支持,写起来方便
- 可以直接引用给 AI 使用
Markdown 的基本语法:
# 一级标题
## 二级标题
### 三级标题
- 无序列表项
- 列表项 2
1. 有序列表项
2. 列表项 2
**粗体** 和 *斜体*
| 表头1 | 表头2 |
|------|------|
| 内容1 | 内容2 |
知识文档的设计原则
原则一:对 AI 友好
AI 读取文档时,需要能快速找到关键信息。好的文档:
- 有清晰的标题层次
- 关键信息用列表或表格呈现(不要大段大段的文字)
- 有明确的分区(背景/方法/示例/注意事项)
原则二:方便人类维护
你或同事需要定期更新这些文档,所以:
- 结构不要太复杂
- 每次更新只需要改一处地方
- 有更新记录(什么时候改了什么)
原则三:实用而非完美
不要追求完美,能用才是关键:
- 宁可写得粗糙但及时,不要等到”完善了再记录”
- 允许文档随着实践不断更新
实用文档模板:产品知识库
文件名: 产品知识库.md
# [产品名] 知识库
**最后更新:** 2025-01-15
## 1. 产品概述
**一句话介绍:** [产品名] 是为 [目标用户] 设计的 [产品类型],
帮助他们 [解决什么问题],达到 [什么效果]。
**核心价值主张:**
- 主要优势 1:[说明]
- 主要优势 2:[说明]
- 主要优势 3:[说明]
## 2. 目标用户
| 用户类型 | 特征 | 主要痛点 | 关注重点 |
|---------|------|---------|---------|
| 类型 A | [描述] | [痛点] | [关注点] |
| 类型 B | [描述] | [痛点] | [关注点] |
## 3. 产品功能(重要功能说明)
### [功能1 名称]
**是什么:** [简短说明]
**解决什么问题:** [说明]
**典型使用场景:** [举例]
**限制或注意事项:** [如有]
### [功能2 名称]
...
## 4. 常见客户问题
**Q:[常见问题1]**
A:[标准回答]
**Q:[常见问题2]**
A:[标准回答]
## 5. 我们 vs 竞品
| 对比维度 | 我们 | 竞品 A | 竞品 B |
|---------|-----|--------|--------|
| [维度1] | [我们] | [竞品A] | [竞品B] |
## 6. 禁止事项和注意点
- 不要承诺 [某功能] - 这个功能还在开发中
- 价格要引用最新的报价单,不要用这个文件里的价格
- [其他注意事项]
实用文档模板:工作方法手册
文件名: 月报工作手册.md
# 月度报告工作手册
**适用场景:** 每月最后一个工作日
## 所需材料清单
□ 当月销售数据 CSV(从 [系统名] 导出)
□ 上月报告(作为对比参考)
□ 本月重要事件记录(平时在日志里记)
## 执行步骤
### 步骤 1:数据准备(30分钟)
1. 登录 [系统名]
2. 进入"数据导出"→选择当月日期范围
3. 导出为 CSV,命名格式:`YYYY-MM-销售数据.csv`
### 步骤 2:数据处理(使用 AI,10分钟)
发给 AI 的提示词(复制使用):
\```
请分析以下销售数据,计算:
1. 总销售额
2. 各区域销售额排名
3. 环比增长率
4. 前三名和后三名产品
数据:[上传 CSV 文件]
\```
### 步骤 3:报告生成(使用 AI,10分钟)
提示词:
\```
基于以上分析,生成月度报告,格式参考附件模板
\```
### 步骤 4:人工审核(20分钟)
□ 检查所有数字是否准确
□ 检查环比数据是否和上月报告一致
□ 补充本月的重要事件和说明
□ 确认报告格式符合规范
### 步骤 5:分发(5分钟)
- 抄送:[收件人列表]
- 主题格式:[X月] 部门月报 - [日期]
## 质量标准
- 所有数字经过人工核验
- 有环比对比
- 有 1-2 段文字分析,不只是数字
- 格式与上月一致
## 常见问题
**Q:数据导出失败怎么办?**
A:联系 IT 部门 [联系方式],或手动从 [备用方式] 获取数据
如何开始写你的第一个知识文档
不要等到准备好再开始,从现在开始:
- 新建一个文件
knowledge/我的工作经验.md - 写下今天你做的一件重复性工作的步骤
- 写下这件事有什么注意事项
- 保存
就这样,你的知识库建立起来了。以后每次做重复性工作,先花 5 分钟把要点更新进去。
常见问题
Q:文档写了但经常忘记更新怎么办? A:在日历里设置提醒,比如每月1日提醒”更新知识库”。或者养成”做完一件事就记录”的习惯。
Q:写文档花时间,值得吗? A:第一次写确实要花时间,但之后每次节省的时间远超过写文档的时间。比如月报手册写一次要 1 小时,但每月执行时节省 2 小时,3 个月就回本了。
下一节,我们来学习如何让 AI 直接读取你的知识库文档,真正实现知识库的价值。
标记本节教程为已读
记录您的学习进度,方便后续查看。