用 Cline Rules 实现「README 编写」：规则文件写法

如果你在文档仓库与文档站里反复做README 编写，可以考虑把经验沉淀为一个 Skill：写清触发条件、步骤、输出格式和边界，让智能体代劳重复部分，人只负责把关。

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

这个技能做什么

处理流程分四步：

1. 识别项目用途
2. 整理安装与运行命令
3. 写最小示例
4. 补充贡献与许可说明

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

在 Cline Rules 中是什么形态

Cline 支持在项目中用 .clinerules 写规则（可以是单个文件，也可以是存放多个 Markdown 文件的目录），把团队流程与约束长期交给智能体。

规则随仓库提交，作用于该项目；也可以在全局规则中放个人习惯，二者叠加生效。

示例配置

.clinerules/readme-writer.md 示例（示意）：

# README 编写

## 触发
用户提到“README 编写”或提供代码仓库时。

## 流程
1. 识别项目用途
2. 整理安装与运行命令
3. 写最小示例
4. 补充贡献与许可说明

## 交付
README 文档

## 边界
- 文中的命令和接口要与当前代码逐一核对。
- 信息不足时先提问，不要自行编造数据或事实。

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

安装与启用步骤

1. 在项目根目录建立 .clinerules/ 目录
2. 新建 readme-writer.md，写触发条件、流程、交付与边界
3. 在 Cline 中描述任务，观察是否遵循规则
4. 需要时在规则面板中开关该规则
5. 提交到仓库共享

实操：一次完整的运行

假设你在文档仓库与文档站中发出这样的请求（虚构示例）：

这是今天的代码仓库，按团队的README 编写流程处理一下。

智能体识别到任务与「README 编写」相关后，会依次识别项目用途、整理安装与运行命令、写最小示例、补充贡献与许可说明。最终交付README 文档，并在末尾列出需要人工确认的内容。你的工作是对照原始代码仓库抽查两三处关键信息，确认无误后再使用。

测试与验收

让 Cline 在计划模式下先给出计划，检查计划是否包含规则中的每个步骤。

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

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

常见坑

• 规则太多太杂，互相冲突。
• 在规则里写需要密钥的命令，导致密钥出现在上下文中。
• 只写了步骤，没写交付格式，导致每次输出的README 文档结构不同。
• 没有给出样例，智能体对“好结果”的理解与你不一致；在参考资料里放一两份范例会明显改善。

延伸阅读

• README 编写 · 常见坑
• README 编写 · 纯提示词版
• README 编写 · 检查清单
• 架构决策记录 · Cline Rules 版
• 从工单生成 FAQ · Cline Rules 版
• 智能体Skills 分类：625 个技能 × 32 个角度

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