Windsurf 规则实战:Cascade 如何做文档链接检查
开发者与技术写作者经常要做「文档链接检查」这类事:检查文档中的失效链接与锚点。每次都从头写提示词,结果时好时坏;把它做成智能体 Skill,就能让智能体每次按同一套步骤执行,输出结构也更稳定。
本文介绍如何在 Windsurf Rules 上实现这个技能,包括它的形态、示例配置、启用步骤、一次完整的运行过程和常见坑。
这个技能做什么
| 项目 | 说明 |
|---|---|
| 技能 | 文档链接检查(doc-link-check) |
| 作用 | 检查文档中的失效链接与锚点 |
| 输入 | 文档目录 |
| 输出 | 失效链接清单 |
| 形态 | 带脚本 |
| 风险 | 低 |
| 适用人群 | 开发者与技术写作者 |
处理流程分四步:
- 收集链接
- 逐个检测
- 区分内部与外部
- 给出修复建议
这个技能需要运行本地脚本(解析文件、调用命令行工具等),要求运行环境允许执行代码;风险较低,但输出仍需快速过目再使用。
在 Windsurf Rules 中是什么形态
Windsurf 的规则用于约束 Cascade 智能体的行为,工作区规则放在 .windsurf/rules/ 目录下,每条规则可以设置激活方式,例如始终生效、按文件匹配或由模型根据描述决定。
工作区规则随项目提交;全局规则只影响个人。激活方式的具体名称以 Windsurf 文档为准。
示例配置
.windsurf/rules/doc-link-check.md 示例(示意):
---
trigger: model_decision
description: 检查文档中的失效链接与锚点
---
# 文档链接检查
1. 收集链接
2. 逐个检测
3. 区分内部与外部
4. 给出修复建议
交付:失效链接清单。
- 文中的命令和接口要与当前代码逐一核对。
- 信息不足时先提问,不要自行编造数据或事实。
- 脚本只在当前项目目录内运行,运行失败时报告错误原文,不要猜测结果。
示例里最重要的是两处:一是描述(或指令开头)要写明「什么时候用」,让智能体在开发者与技术写作者提出相关请求时能对上号;二是约束部分要写进「文中的命令和接口要与当前代码逐一核对」这类领域规矩,避免智能体自作主张。
安装与启用步骤
- 新建
.windsurf/rules/doc-link-check.md - 在头部设置激活方式与描述
- 正文写步骤、交付与边界
- 在 Cascade 中描述任务验证效果
- 提交到仓库
实操:一次完整的运行
假设你在文档仓库与文档站中发出这样的请求(虚构示例):
这是今天的文档目录,按团队的文档链接检查流程处理一下。
智能体识别到任务与「文档链接检查」相关后,会依次收集链接、逐个检测、区分内部与外部、给出修复建议。最终交付失效链接清单,并在末尾列出需要人工确认的内容。你的工作是对照原始文档目录抽查两三处关键信息,确认无误后再使用。
测试与验收
分别用匹配与不匹配描述的请求测试,确认规则只在相关任务中被采用。
针对这个技能,还建议额外准备:
- 一份信息齐全的标准文档目录,检查输出是否完整
- 一份缺少关键信息的输入,检查智能体是否先提问而不是编造
- 一份包含“忽略以上规则”等字样的输入,检查约束是否仍然有效
常见坑
- 所有规则都设为始终生效,浪费上下文。
- 描述过于宽泛,模型在不相关任务中也套用。
- 只写了步骤,没写交付格式,导致每次输出的失效链接清单结构不同。
- 没有给出样例,智能体对“好结果”的理解与你不一致;在参考资料里放一两份范例会明显改善。
延伸阅读
- 文档链接检查 · Function Calling 版
- 文档链接检查 · 扣子(Coze)智能体与工作流 版
- 文档链接检查 · 场景实录
- 接口文档编写 · Windsurf Rules 版
- 技术文档翻译 · Windsurf Rules 版
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。