From 58c4a5161ef6e884ce40ac163dc3a0c20e213f0a Mon Sep 17 00:00:00 2001 From: cat-shark Date: Sat, 10 Oct 2026 14:53:10 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E8=A7=84=E5=88=99=E6=96=87=E4=BB=B6?= =?UTF-8?q?=E7=BB=9F=E4=B8=80=E4=B8=BA=E5=90=8D=E7=A7=B0/=E5=8A=9F?= =?UTF-8?q?=E8=83=BD/=E4=BD=95=E6=97=B6=E7=94=A8=E4=B8=89=E6=AE=B5?= =?UTF-8?q?=E5=BC=80=E5=A4=B4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .agents/roles/README.md | 21 +++++++++++++++++++++ .agents/roles/parallel-and-delegation.md | 3 +++ .agents/roles/todo-discipline.md | 3 +++ AGENTS.md | 1 + 4 files changed, 28 insertions(+) diff --git a/.agents/roles/README.md b/.agents/roles/README.md index c2e46ea..7c426b7 100644 --- a/.agents/roles/README.md +++ b/.agents/roles/README.md @@ -27,6 +27,27 @@ 因此在 `lpt-be` 这类子目录里干活时,meta 的 `AGENTS.md` 仍会被读到—— 这正是各子项目不再重复通用规则的前提。 +## 规则文件的写法(强制) + +每个规则文件的**开头必须是如下三段**,顺序不变,方便 agent 在决定是否继续读之前就能判断该不该用: + +1. **名称**——作为 `#` 一级标题; +2. **功能简述**——一句话说明这条规则解决什么问题; +3. **关键字 / 情况**——告诉 agent **何时需要用到这条规则**。这部分要简洁(一行枚举触发场景即可),**不要在这里展开内容**,正文放到后面。 + +模板: + +```markdown +# <名称> + +- **功能**:<一句话说明这条规则做什么> +- **何时用**:<触发场景 / 关键字的简短枚举> + +## <正文…> +``` + +新增或修改规则后自查:标题是名称?有「功能」行?有「何时用」行?「何时用」是否够短? + ## 规则清单 | 规则 | 文件 | 触发点 | diff --git a/.agents/roles/parallel-and-delegation.md b/.agents/roles/parallel-and-delegation.md index 3a8266e..d02f2ad 100644 --- a/.agents/roles/parallel-and-delegation.md +++ b/.agents/roles/parallel-and-delegation.md @@ -1,5 +1,8 @@ # 并行与委派 +- **功能**:把「什么时候并行、什么时候串行、怎么派活」固定下来,避免串行浪费时间、也避免盲目并行互相覆盖。 +- **何时用**:开工排期时;判断多个任务该并行还是串行时;派发子任务给 subagent 时;同一目录出现第二个写入者时;跨仓库同时改动时。 + ## 为什么有这条规则 本工作区是多仓库结构(meta + 5 个子项目),可并行的活儿很多,但同一目录只允许一个写入者。 diff --git a/.agents/roles/todo-discipline.md b/.agents/roles/todo-discipline.md index c000e2e..2be0b33 100644 --- a/.agents/roles/todo-discipline.md +++ b/.agents/roles/todo-discipline.md @@ -1,5 +1,8 @@ # todo 收口纪律 +- **功能**:让待办列表始终反映真实进度——做完的事当场收口,不留「已经做完、却还显示未完成」的陈旧条目。 +- **何时用**:创建或更新 todo 时;一项工作做完时;`git commit` 成功后;准备发出最终回复前;会话被压缩后;发现待办状态与事实不符时。 + ## 为什么有这条规则 2026-10-09 的一次会话里:`todo` 工具 `create` 23 次,`update` 只有 14 次—— diff --git a/AGENTS.md b/AGENTS.md index 6c636a9..6b06523 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -92,6 +92,7 @@ clone 完成后,进入或修改某个子项目前,先读取该子项目根 - **项目专属规则** 留在各仓库自己的 `AGENTS.md`(后端迁移写法、前端测试隔离之类)。 - 新增通用规则时,记得在 `AGENTS.md` 里挂上入口:`.agents/roles/` **不是自动加载目录**, 只有 `AGENTS.md`(与按描述触发的 skills)会被读到,不引用等于不生效。 +- **规则文件开头必须是三段**:名称(一级标题)→ 功能简述 → 关键字/情况(何时用,要简短,正文放后面)。 - 现行通用规则:`todo-discipline.md`(提交后收口 / 轮末对账 / 压缩后对账)、`parallel-and-delegation.md`(默认并行 / 单写入者 / 派发说明)。 ### 技能