📝 docs(agent): standardize intelligent agent wording
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
# playbook
|
||||
|
||||
Playbook:工程规范与代理规则合集,当前覆盖:
|
||||
Playbook:工程规范与智能体规则合集,当前覆盖:
|
||||
|
||||
- TSL(`.tsl`/`.tsf`)
|
||||
- C++
|
||||
@@ -27,7 +27,7 @@ Playbook:工程规范与代理规则合集,当前覆盖:
|
||||
|
||||
## templates/(项目架构模板)
|
||||
|
||||
`templates/` 目录除了语言配置模板外,还包含 AI 代理工作环境的项目架构模板:
|
||||
`templates/` 目录除了语言配置模板外,还包含 AI 智能体工作环境的项目架构模板:
|
||||
|
||||
- `templates/memory-bank/`:项目上下文文档模板(project-brief、tech-context、system-patterns、active-context、progress、decisions)
|
||||
- `templates/prompts/`:任务入口模板(agent-behavior、clarify、verify-change、close-task、update-memory、code-review),不是流程权威
|
||||
@@ -70,15 +70,15 @@ project_name = "MyProject"
|
||||
|
||||
## rulesets/(规则集模板库 - 三层架构)
|
||||
|
||||
> **重要说明**:playbook 仓库中的 `rulesets/` 是**规则集模板库**,不是 playbook 项目自身的代理规则。
|
||||
> **重要说明**:playbook 仓库中的 `rulesets/` 是**规则集模板库**,不是 playbook 项目自身的智能体规则。
|
||||
>
|
||||
> Playbook 本身不包含源代码,因此不需要 AI 代理遵循规则。`rulesets/` 存在的目的是:
|
||||
> Playbook 本身不包含源代码,因此不需要 AI 智能体遵循规则。`rulesets/` 存在的目的是:
|
||||
>
|
||||
> 1. 作为**模板源**,供其他项目复制
|
||||
> 2. 通过 playbook.py 的 `[sync_standards]` 部署到目标项目的 `.agents/`
|
||||
> 3. 目标项目的 AI 代理读取**项目根目录的 `.agents/`**(从模板生成)
|
||||
> 3. 目标项目的 AI 智能体读取**项目根目录的 `.agents/`**(从模板生成)
|
||||
|
||||
`rulesets/` 是 AI 代理规则集模板(三层架构设计):
|
||||
`rulesets/` 是 AI 智能体规则集模板(三层架构设计):
|
||||
|
||||
### 三层架构设计
|
||||
|
||||
@@ -101,7 +101,7 @@ Layer 3: docs/ (权威静态文档)
|
||||
| 层级 | 加载方式 | 内容 | 作用 |
|
||||
| ------- | ------------------------------ | ------------------------------ | -------------------------- |
|
||||
| Layer 1 | 自动,始终在上下文 | 语言特有的核心约束 | 快速判断能做/不能做 |
|
||||
| Layer 2 | `$<skill-name>` 触发或代理判定 | 操作指南、最佳实践、工作流 | 指导具体怎么做 |
|
||||
| Layer 2 | `$<skill-name>` 触发或智能体判定 | 操作指南、最佳实践、工作流 | 指导具体怎么做 |
|
||||
| Layer 3 | 按需读取特定章节 | 完整语言手册、代码风格、工具链 | 最终权威(冲突时以此为准) |
|
||||
|
||||
**目录结构**:
|
||||
@@ -228,13 +228,13 @@ Layer 3: docs/ (权威静态文档)
|
||||
1. **仓库级(跨语言)共识**:对所有语言都成立的规则与流程。
|
||||
- 提交信息:`docs/common/commit_message.md`
|
||||
- 行尾与文本规范:`.gitattributes`
|
||||
- 代理最低要求:`.agents/*`(工作原则、质量底线、安全边界)
|
||||
- 智能体最低要求:`.agents/*`(工作原则、质量底线、安全边界)
|
||||
2. **语言级(Language-specific)规范**:只对某个语言成立的风格与工具。
|
||||
- 例如 TSL 的命名/文件顶层声明限制、C++ 的 `.clang-format/.clang-tidy`、Python 的 `ruff`、TypeScript 的 ESLint/类型约束等。
|
||||
|
||||
**建议**:仓库级规则尽量少且稳定;语言级规则各自独立,避免互相"污染"。
|
||||
|
||||
本仓库提供多套代理规则集(同步后位于目标项目的 `.agents/tsl/` / `.agents/cpp/` / `.agents/python/` / `.agents/typescript/` / `.agents/markdown/`):
|
||||
本仓库提供多套智能体规则集(同步后位于目标项目的 `.agents/tsl/` / `.agents/cpp/` / `.agents/python/` / `.agents/typescript/` / `.agents/markdown/`):
|
||||
|
||||
- 各规则集都包含语言特有的核心约定
|
||||
- 并在 `index.md` 中叠加语言级"硬约束"(TSL/TSF 语法限制、C++23/Modules、Python 风格、TypeScript 类型约束、Markdown 代码格式化等)
|
||||
|
||||
Reference in New Issue
Block a user