文档链接检查 Skill 定制指南:改风格、改阈值、改输出格式
开发者与技术写作者经常要做「文档链接检查」这类事:检查文档中的失效链接与锚点。每次都从头写提示词,结果时好时坏;把它做成智能体 Skill,就能让智能体每次按同一套步骤执行,输出结构也更稳定。
通用版的「文档链接检查」能覆盖大多数情况,但每个团队都有自己的习惯。下面列出最值得调整的几个地方。
可调参数一览
| 参数 | 默认 | 可以怎么改 |
|---|---|---|
| 输出格式 | 失效链接清单 | 改成团队模板、表格或固定小标题 |
| 详略程度 | 适中 | 给领导看的精简版 / 给执行者看的详细版 |
| 语气风格 | 中性 | 按团队文风、对外或对内调整 |
| 严格程度 | 标注不确定项 | 提高到“任何推断都要给依据” |
| 步骤 | 4 步 | 增加团队特有的检查步骤 |
改写示例:description
通用版:
检查文档中的失效链接与锚点。当用户提到文档链接检查时使用。
团队版(示意):
按本团队规范进行文档链接检查:先读取 reference.md 中的模板与术语表,再处理文档目录。当团队成员提到文档链接检查或上传相关材料时使用。
改写示例:增加团队步骤
## 步骤
1. 收集链接
2. 逐个检测
3. 区分内部与外部
4. 给出修复建议
5. 对照 reference.md 中的团队检查表逐项确认
6. 按团队模板输出,并在开头写一句结论
按角色出多个版本
同一个技能可以为不同角色准备变体:新人版写得更细,并解释每一步的理由;熟手版只保留关键检查点。也可以在一个技能里用参数区分,例如“简版/详版”。
定制时别丢掉的东西
- 领域底线:文中的命令和接口要与当前代码逐一核对
- 缺信息先提问
- 需人工确认清单
- 风险较低,但输出仍需快速过目再使用
什么时候用这个技能
- 手头有文档目录,需要在较短时间内得到失效链接清单
- 同类任务每周出现多次,希望每次处理方式一致
- 结果要交给同事或上级复核,需要统一的结构和清楚的依据
- 新人接手这类工作,需要一个可以照着做的标准流程
反过来,如果只是偶尔做一次,或者任务高度依赖现场判断,直接和文档仓库与文档站里的智能体对话即可,不必专门封装成技能。
交付物结构示例
建议把失效链接清单固定成下面的结构(示意),方便复核与归档:
## 结论
一句话说明最重要的发现或结果
## 主要内容
- 收集链接:……
- 逐个检测:……
- 区分内部与外部:……
- 给出修复建议:……
## 依据
- 引用输入中的具体位置或数据
## 需人工确认
- ……(没有则写“无”)
结构固定之后,复核的人只要先看“结论”和“需人工确认”两部分,就能快速判断结果能否使用。
延伸阅读
- 文档链接检查 · 常见问题
- 文档链接检查 · AGENTS.md 版
- 文档链接检查 · MCP 服务 版
- 接口文档编写 · 定制指南
- 技术文档翻译 · 定制指南
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。