「文档入库整理」的 SKILL.md 怎么写:逐段拆解与完整示例
知识管理与客服团队经常要做「文档入库整理」这类事:把文档清洗分段后导入知识库。每次都从头写提示词,结果时好时坏;把它做成智能体 Skill,就能让智能体每次按同一套步骤执行,输出结构也更稳定。
本文以「文档入库整理」为例,逐段讲解 SKILL.md 的写法。SKILL.md 是 Claude Agent Skills 采用的格式:YAML 头 + Markdown 正文,其结构思路也适用于其他平台的规则文件与指令。
完整示例
---
name: doc-ingest
description: 把文档清洗分段后导入知识库。当用户提到文档入库整理、或给出原始文档并希望得到入库数据时使用。
---
# 文档入库整理
## 输入
- 原始文档
- 若缺少关键信息,先列出需要补充的问题
## 步骤
1. 清洗格式
2. 按结构分段
3. 补充元数据
4. 导入并抽检
## 输出
- 入库数据
- 末尾附「需人工确认」清单(没有则写“无”)
## 约束
- 回答必须有出处,没有依据时如实说明。
- 信息不足时先提问,不要自行编造数据或事实。
- 脚本只在当前项目目录内运行,运行失败时报告错误原文,不要猜测结果。
## 脚本
- 需要解析或批量处理时运行 `python scripts/doc_ingest.py <路径>`,读取其输出后再总结
第一段:name
name 用小写字母和连字符,例如 doc-ingest,与文件夹名保持一致,方便检索和引用。不要用空格、中文或版本号。
第二段:description(最关键)
智能体平时只看得到 description,靠它判断要不要加载技能。好的 description 同时回答两件事:做什么(把文档清洗分段后导入知识库),什么时候用(用户提到文档入库整理或给出原始文档时)。
反例:“一个很有用的文档入库整理工具”——没有触发条件,智能体很难对上号。
第三段:输入与步骤
输入写清楚需要什么材料,并要求缺信息时先提问。步骤用编号列表,每步一个动作:
- 清洗格式
- 按结构分段
- 补充元数据
- 导入并抽检
步骤是给智能体的执行顺序,不是给人看的说明书,越具体越好。
第四段:输出
写明交付物(入库数据)以及固定结构。建议统一附上“需人工确认”清单,让复核的人知道看哪里。
第五段:约束
约束写的是不能做什么、遇到什么情况要停下:
- 回答必须有出处,没有依据时如实说明。
- 信息不足时先提问,不要自行编造数据或事实。
- 脚本只在当前项目目录内运行,运行失败时报告错误原文,不要猜测结果。
渐进式加载:把长资料拆出去
团队规范、长模板、术语表不要塞进 SKILL.md 正文,放到同目录的 reference.md 等文件中,在正文里写“需要时阅读 reference.md”。这样平时加载很轻,需要时再读取细节。需要确定性处理的部分(解析、统计、校验)写成脚本放在 scripts/ 下,正文中说明调用方式。
目录结构
.claude/skills/doc-ingest/
├── SKILL.md
├── scripts/doc_ingest.py
└── reference.md # 可选:团队规范、模板等长资料,按需加载
写完之后
用三种不同说法描述任务,看技能是否都能被触发;再用一个无关请求确认不会误触发。之后参考测试用例与效果评估持续改进。
交付物结构示例
建议把入库数据固定成下面的结构(示意),方便复核与归档:
## 结论
一句话说明最重要的发现或结果
## 主要内容
- 清洗格式:……
- 按结构分段:……
- 补充元数据:……
- 导入并抽检:……
## 依据
- 引用输入中的具体位置或数据
## 需人工确认
- ……(没有则写“无”)
结构固定之后,复核的人只要先看“结论”和“需人工确认”两部分,就能快速判断结果能否使用。
延伸阅读
- 文档入库整理 · 测试用例
- 文档入库整理 · 极简与进阶
- 文档入库整理 · 定制指南
- 知识库效果评估 · SKILL.md 写法
- 找专家 · SKILL.md 写法
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。