用 Windsurf Rules 实现「数据字典生成」：规则与激活方式

如果你在数据库客户端与查询工具里反复做数据字典生成，可以考虑把经验沉淀为一个 Skill：写清触发条件、步骤、输出格式和边界，让智能体代劳重复部分，人只负责把关。

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

这个技能做什么

项目	说明
技能	数据字典生成（`data-dictionary`）
作用	根据库表结构与注释生成数据字典文档
输入	数据库结构
输出	数据字典
形态	带脚本
风险	低
适用人群	后端与数据工程师

处理流程分四步：

读取表与字段
整理含义与示例
标出敏感字段
输出文档

这个技能需要运行本地脚本（解析文件、调用命令行工具等），要求运行环境允许执行代码；风险较低，但输出仍需快速过目再使用。

在 Windsurf Rules 中是什么形态

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

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

示例配置

.windsurf/rules/data-dictionary.md 示例（示意）：

---
trigger: model_decision
description: 根据库表结构与注释生成数据字典文档
---

# 数据字典生成

1. 读取表与字段
2. 整理含义与示例
3. 标出敏感字段
4. 输出文档

交付：数据字典。
- 默认使用只读连接，任何写操作都要人工确认。
- 信息不足时先提问，不要自行编造数据或事实。
- 脚本只在当前项目目录内运行，运行失败时报告错误原文，不要猜测结果。

示例里最重要的是两处：一是描述（或指令开头）要写明「什么时候用」，让智能体在后端与数据工程师提出相关请求时能对上号；二是约束部分要写进「默认使用只读连接，任何写操作都要人工确认」这类领域规矩，避免智能体自作主张。

安装与启用步骤

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

实操：一次完整的运行

假设你在数据库客户端与查询工具中发出这样的请求（虚构示例）：

这是今天的数据库结构，按团队的数据字典生成流程处理一下。

智能体识别到任务与「数据字典生成」相关后，会依次读取表与字段、整理含义与示例、标出敏感字段、输出文档。最终交付数据字典，并在末尾列出需要人工确认的内容。你的工作是对照原始数据库结构抽查两三处关键信息，确认无误后再使用。

测试与验收

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

针对这个技能，还建议额外准备：

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

常见坑

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

延伸阅读

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