docs: 规则文件统一为名称/功能/何时用三段开头

This commit is contained in:
cat-shark
2026-10-10 14:53:10 +08:00
parent 7767fbd689
commit 58c4a5161e
4 changed files with 28 additions and 0 deletions
+21
View File
@@ -27,6 +27,27 @@
因此在 `lpt-be` 这类子目录里干活时,meta 的 `AGENTS.md` 仍会被读到——
这正是各子项目不再重复通用规则的前提。
## 规则文件的写法(强制)
每个规则文件的**开头必须是如下三段**,顺序不变,方便 agent 在决定是否继续读之前就能判断该不该用:
1. **名称**——作为 `#` 一级标题;
2. **功能简述**——一句话说明这条规则解决什么问题;
3. **关键字 / 情况**——告诉 agent **何时需要用到这条规则**。这部分要简洁(一行枚举触发场景即可),**不要在这里展开内容**,正文放到后面。
模板:
```markdown
# <名称>
- **功能**:<一句话说明这条规则做什么>
- **何时用**:<触发场景 / 关键字的简短枚举>
## <正文…>
```
新增或修改规则后自查:标题是名称?有「功能」行?有「何时用」行?「何时用」是否够短?
## 规则清单
| 规则 | 文件 | 触发点 |