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