文档链接检查 Skill 两种写法对比:五行提示词还是完整技能包
如果你在文档仓库与文档站里反复做文档链接检查,可以考虑把经验沉淀为一个 Skill:写清触发条件、步骤、输出格式和边界,让智能体代劳重复部分,人只负责把关。
很多人纠结一开始要不要把技能写得很完整。答案是:先极简,再按需升级。下面对比「文档链接检查」的两种写法。
极简版:五行就够
你负责文档链接检查。
输入:文档目录。
步骤:收集链接;逐个检测;区分内部与外部;给出修复建议。
输出:失效链接清单。
信息不足先提问,不要编造。
适合个人临时使用、验证流程是否合理。缺点是输出格式不够稳定,边界情况处理不一致。
进阶版:完整技能包
.claude/skills/doc-link-check/
├── SKILL.md
├── scripts/doc_link_check.py
└── reference.md # 可选:团队规范、模板等长资料,按需加载
进阶版在极简版基础上增加:
- 精确的 description,确保自动触发
- 固定的输出结构与“需人工确认”清单
- 约束段落(权限、领域规矩、不可逆操作)
- 参考资料(团队规范、范例),按需加载
- 脚本,负责确定性的解析与校验
- tests/ 测试样例
对比
| 维度 | 极简版 | 进阶版 |
|---|---|---|
| 编写时间 | 几分钟 | 一到两小时 |
| 输出稳定性 | 一般 | 较好 |
| 边界处理 | 依赖模型自觉 | 有明确规则 |
| 团队共享 | 不方便 | 可评审、可版本化 |
| 适用 | 个人试用 | 日常高频、多人使用 |
什么时候该升级
- 每周使用超过几次
- 输出要给别人看或进入正式流程
- 已经发现两次以上同类错误
- 风险较低,但输出仍需快速过目再使用
升级时参考SKILL.md 写法,并用测试用例验证。
交付物结构示例
建议把失效链接清单固定成下面的结构(示意),方便复核与归档:
## 结论
一句话说明最重要的发现或结果
## 主要内容
- 收集链接:……
- 逐个检测:……
- 区分内部与外部:……
- 给出修复建议:……
## 依据
- 引用输入中的具体位置或数据
## 需人工确认
- ……(没有则写“无”)
结构固定之后,复核的人只要先看“结论”和“需人工确认”两部分,就能快速判断结果能否使用。
平台选择建议
同一个「文档链接检查」技能可以落在不同平台上,选择时主要看你在哪里工作、要不要执行代码、要不要接外部系统:
- Cline Rules:Cline 支持在项目中用
.clinerules写规则(可以是单个文件。详见Cline Rules 版 - LangChain / LangGraph 工具:LangChain 用 @tool 装饰器把函数变成工具。详见LangChain / LangGraph 工具 版
- Claude Code Skill:Claude Code 的 Agent Skills 以文件夹为单位:一个 SKILL.md(YAML 头写 name 与 description)加上可选的脚本和参考资料。智能体平时只看到 description。详见Claude Code Skill 版
这个技能需要运行本地脚本(解析文件、调用命令行工具等),要求运行环境允许执行代码,可据此排除不支持相应能力的平台。
智能体与人的分工
技能不是把工作全部交出去,而是把重复、机械的部分交给智能体,人把住判断和责任:
| 步骤 | 智能体负责 | 人负责 |
|---|---|---|
| 收集链接 | 按指令完成并给出依据 | 抽查关键处,确认无误 |
| 逐个检测 | 按指令完成并给出依据 | 抽查关键处,确认无误 |
| 区分内部与外部 | 按指令完成并给出依据 | 抽查关键处,确认无误 |
| 给出修复建议 | 按指令完成并给出依据 | 抽查关键处,确认无误 |
| 最终交付 | 整理失效链接清单 | 决定是否采用、是否对外 |
风险较低,但输出仍需快速过目再使用。
延伸阅读
- 文档链接检查 · Windsurf Rules 版
- 文档链接检查 · Dify 工作流 版
- 文档链接检查 · SKILL.md 写法
- 接口文档编写 · 极简与进阶
- 技术文档翻译 · 极简与进阶
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。