「升级迁移指南」是开发者与技术写作者的高频任务。它的输入通常是版本差异,期望得到的是迁移指南。这类有固定流程、又需要一点判断力的工作,很适合封装成智能体 Skill。

本文介绍如何在 Windsurf Rules 上实现这个技能,包括它的形态、示例配置、启用步骤、一次完整的运行过程和常见坑。

这个技能做什么

项目说明
技能升级迁移指南(migration-guide-writer)
作用为破坏性版本升级编写迁移指南
输入版本差异
输出迁移指南
形态纯提示词
风险低
适用人群开发者与技术写作者

处理流程分四步:

  1. 列出破坏性变更
  2. 写新旧对照
  3. 给出迁移步骤
  4. 附检查清单

这个技能纯指令型,不需要额外脚本或外部连接,复制到大多数平台都能用;风险较低,但输出仍需快速过目再使用。

在 Windsurf Rules 中是什么形态

Windsurf 的规则用于约束 Cascade 智能体的行为,工作区规则放在 .windsurf/rules/ 目录下,每条规则可以设置激活方式,例如始终生效、按文件匹配或由模型根据描述决定。

工作区规则随项目提交;全局规则只影响个人。激活方式的具体名称以 Windsurf 文档为准。

示例配置

.windsurf/rules/migration-guide-writer.md 示例(示意):

---
trigger: model_decision
description: 为破坏性版本升级编写迁移指南
---

# 升级迁移指南

1. 列出破坏性变更
2. 写新旧对照
3. 给出迁移步骤
4. 附检查清单

交付:迁移指南。
- 文中的命令和接口要与当前代码逐一核对。
- 信息不足时先提问,不要自行编造数据或事实。

示例里最重要的是两处:一是描述(或指令开头)要写明「什么时候用」,让智能体在开发者与技术写作者提出相关请求时能对上号;二是约束部分要写进「文中的命令和接口要与当前代码逐一核对」这类领域规矩,避免智能体自作主张。

安装与启用步骤

  1. 新建 .windsurf/rules/migration-guide-writer.md
  2. 在头部设置激活方式与描述
  3. 正文写步骤、交付与边界
  4. 在 Cascade 中描述任务验证效果
  5. 提交到仓库

实操:一次完整的运行

假设你在文档仓库与文档站中发出这样的请求(虚构示例):

用升级迁移指南技能处理这份版本差异,输出迁移指南。

智能体识别到任务与「升级迁移指南」相关后,会依次列出破坏性变更、写新旧对照、给出迁移步骤、附检查清单。最终交付迁移指南,并在末尾列出需要人工确认的内容。你的工作是对照原始版本差异抽查两三处关键信息,确认无误后再使用。

测试与验收

分别用匹配与不匹配描述的请求测试,确认规则只在相关任务中被采用。

针对这个技能,还建议额外准备:

  • 一份信息齐全的标准版本差异,检查输出是否完整
  • 一份缺少关键信息的输入,检查智能体是否先提问而不是编造
  • 一份包含“忽略以上规则”等字样的输入,检查约束是否仍然有效

常见坑

  • 所有规则都设为始终生效,浪费上下文。
  • 描述过于宽泛,模型在不相关任务中也套用。
  • 只写了步骤,没写交付格式,导致每次输出的迁移指南结构不同。
  • 没有给出样例,智能体对“好结果”的理解与你不一致;在参考资料里放一两份范例会明显改善。

延伸阅读

说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。