📝 docs(agent): standardize intelligent agent wording
This commit is contained in:
@@ -1,6 +1,6 @@
|
|||||||
# playbook
|
# playbook
|
||||||
|
|
||||||
Playbook:工程规范与代理规则合集,当前覆盖:
|
Playbook:工程规范与智能体规则合集,当前覆盖:
|
||||||
|
|
||||||
- TSL(`.tsl`/`.tsf`)
|
- TSL(`.tsl`/`.tsf`)
|
||||||
- C++
|
- C++
|
||||||
@@ -27,7 +27,7 @@ Playbook:工程规范与代理规则合集,当前覆盖:
|
|||||||
|
|
||||||
## templates/(项目架构模板)
|
## templates/(项目架构模板)
|
||||||
|
|
||||||
`templates/` 目录除了语言配置模板外,还包含 AI 代理工作环境的项目架构模板:
|
`templates/` 目录除了语言配置模板外,还包含 AI 智能体工作环境的项目架构模板:
|
||||||
|
|
||||||
- `templates/memory-bank/`:项目上下文文档模板(project-brief、tech-context、system-patterns、active-context、progress、decisions)
|
- `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),不是流程权威
|
- `templates/prompts/`:任务入口模板(agent-behavior、clarify、verify-change、close-task、update-memory、code-review),不是流程权威
|
||||||
@@ -70,15 +70,15 @@ project_name = "MyProject"
|
|||||||
|
|
||||||
## rulesets/(规则集模板库 - 三层架构)
|
## rulesets/(规则集模板库 - 三层架构)
|
||||||
|
|
||||||
> **重要说明**:playbook 仓库中的 `rulesets/` 是**规则集模板库**,不是 playbook 项目自身的代理规则。
|
> **重要说明**:playbook 仓库中的 `rulesets/` 是**规则集模板库**,不是 playbook 项目自身的智能体规则。
|
||||||
>
|
>
|
||||||
> Playbook 本身不包含源代码,因此不需要 AI 代理遵循规则。`rulesets/` 存在的目的是:
|
> Playbook 本身不包含源代码,因此不需要 AI 智能体遵循规则。`rulesets/` 存在的目的是:
|
||||||
>
|
>
|
||||||
> 1. 作为**模板源**,供其他项目复制
|
> 1. 作为**模板源**,供其他项目复制
|
||||||
> 2. 通过 playbook.py 的 `[sync_standards]` 部署到目标项目的 `.agents/`
|
> 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 1 | 自动,始终在上下文 | 语言特有的核心约束 | 快速判断能做/不能做 |
|
||||||
| Layer 2 | `$<skill-name>` 触发或代理判定 | 操作指南、最佳实践、工作流 | 指导具体怎么做 |
|
| Layer 2 | `$<skill-name>` 触发或智能体判定 | 操作指南、最佳实践、工作流 | 指导具体怎么做 |
|
||||||
| Layer 3 | 按需读取特定章节 | 完整语言手册、代码风格、工具链 | 最终权威(冲突时以此为准) |
|
| Layer 3 | 按需读取特定章节 | 完整语言手册、代码风格、工具链 | 最终权威(冲突时以此为准) |
|
||||||
|
|
||||||
**目录结构**:
|
**目录结构**:
|
||||||
@@ -228,13 +228,13 @@ Layer 3: docs/ (权威静态文档)
|
|||||||
1. **仓库级(跨语言)共识**:对所有语言都成立的规则与流程。
|
1. **仓库级(跨语言)共识**:对所有语言都成立的规则与流程。
|
||||||
- 提交信息:`docs/common/commit_message.md`
|
- 提交信息:`docs/common/commit_message.md`
|
||||||
- 行尾与文本规范:`.gitattributes`
|
- 行尾与文本规范:`.gitattributes`
|
||||||
- 代理最低要求:`.agents/*`(工作原则、质量底线、安全边界)
|
- 智能体最低要求:`.agents/*`(工作原则、质量底线、安全边界)
|
||||||
2. **语言级(Language-specific)规范**:只对某个语言成立的风格与工具。
|
2. **语言级(Language-specific)规范**:只对某个语言成立的风格与工具。
|
||||||
- 例如 TSL 的命名/文件顶层声明限制、C++ 的 `.clang-format/.clang-tidy`、Python 的 `ruff`、TypeScript 的 ESLint/类型约束等。
|
- 例如 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 代码格式化等)
|
- 并在 `index.md` 中叠加语言级"硬约束"(TSL/TSF 语法限制、C++23/Modules、Python 风格、TypeScript 类型约束、Markdown 代码格式化等)
|
||||||
|
|||||||
@@ -196,7 +196,7 @@ count := count + 1;
|
|||||||
## 4. 代码实践(Best Practices)
|
## 4. 代码实践(Best Practices)
|
||||||
|
|
||||||
> 本节偏“实践建议”(should),用于提升可读性/可测试性;若目标项目有更严格的约束与检查命令,以项目脚本、CI 配置,或已填写且没有 `<...>` 占位符的
|
> 本节偏“实践建议”(should),用于提升可读性/可测试性;若目标项目有更严格的约束与检查命令,以项目脚本、CI 配置,或已填写且没有 `<...>` 占位符的
|
||||||
> `docs/tsl/toolchain.md` 为准。如果项目对自动化或 AI 代理有额外要求,应把约束直接写进仓库内可见的检查脚本、CI 配置或项目文档,而不是依赖隐藏规范。
|
> `docs/tsl/toolchain.md` 为准。如果项目对自动化或 AI 智能体有额外要求,应把约束直接写进仓库内可见的检查脚本、CI 配置或项目文档,而不是依赖隐藏规范。
|
||||||
|
|
||||||
### 4.1 变量与常量
|
### 4.1 变量与常量
|
||||||
|
|
||||||
|
|||||||
@@ -1,13 +1,13 @@
|
|||||||
# C++ 代理规则集
|
# C++ 智能体规则集
|
||||||
|
|
||||||
本规则集定义 AI/自动化代理在处理 C++ 代码时必须遵守的核心约束。
|
本规则集定义 AI/自动化智能体在处理 C++ 代码时必须遵守的核心约束。
|
||||||
|
|
||||||
## 范围与优先级
|
## 范围与优先级
|
||||||
|
|
||||||
- 作为仓库级基线规则集使用;更靠近代码目录的规则更具体并可覆盖基线。
|
- 作为仓库级基线规则集使用;更靠近代码目录的规则更具体并可覆盖基线。
|
||||||
- 当代理规则与 docs 冲突:安全/合规优先,其次保持仓库一致性。
|
- 当智能体规则与 docs 冲突:安全/合规优先,其次保持仓库一致性。
|
||||||
|
|
||||||
## 代理工作原则(铁律)
|
## 智能体工作原则(铁律)
|
||||||
|
|
||||||
1. 先理解目标与上下文,再动手改代码
|
1. 先理解目标与上下文,再动手改代码
|
||||||
2. 修改要小而清晰;避免无关重构
|
2. 修改要小而清晰;避免无关重构
|
||||||
|
|||||||
+2
-2
@@ -7,11 +7,11 @@
|
|||||||
> - **使用流程**:
|
> - **使用流程**:
|
||||||
>
|
>
|
||||||
> ```text
|
> ```text
|
||||||
> playbook/rulesets/tsl/ → [sync] → your-project/.agents/tsl/ ← AI 代理读取
|
> playbook/rulesets/tsl/ → [sync] → your-project/.agents/tsl/ ← AI 智能体读取
|
||||||
> (模板源) (实际使用)
|
> (模板源) (实际使用)
|
||||||
> ```
|
> ```
|
||||||
|
|
||||||
本目录用于存放 **AI/自动化代理规则集模板**,用于分发到其他项目。
|
本目录用于存放 **AI/自动化智能体规则集模板**,用于分发到其他项目。
|
||||||
|
|
||||||
本仓库将规则按语言拆分为多个规则集模板:
|
本仓库将规则按语言拆分为多个规则集模板:
|
||||||
|
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
# Markdown 代理规则集
|
# Markdown 智能体规则集
|
||||||
|
|
||||||
本规则集定义 AI/自动化代理在处理 Markdown(`.md`)文件时必须遵守的核心约束。
|
本规则集定义 AI/自动化智能体在处理 Markdown(`.md`)文件时必须遵守的核心约束。
|
||||||
|
|
||||||
## 代理工作原则(铁律)
|
## 智能体工作原则(铁律)
|
||||||
|
|
||||||
1. 只调整代码块与行内代码;不改写正文内容
|
1. 只调整代码块与行内代码;不改写正文内容
|
||||||
2. 不改变标题层级、列表结构、段落顺序
|
2. 不改变标题层级、列表结构、段落顺序
|
||||||
|
|||||||
@@ -1,13 +1,13 @@
|
|||||||
# Python 代理规则集
|
# Python 智能体规则集
|
||||||
|
|
||||||
本规则集定义 AI/自动化代理在处理 Python 代码时必须遵守的核心约束。
|
本规则集定义 AI/自动化智能体在处理 Python 代码时必须遵守的核心约束。
|
||||||
|
|
||||||
## 范围与优先级
|
## 范围与优先级
|
||||||
|
|
||||||
- 作为仓库级基线规则集使用;更靠近代码目录的规则更具体并可覆盖基线。
|
- 作为仓库级基线规则集使用;更靠近代码目录的规则更具体并可覆盖基线。
|
||||||
- 当代理规则与 docs 冲突:安全/合规优先,其次保持仓库一致性。
|
- 当智能体规则与 docs 冲突:安全/合规优先,其次保持仓库一致性。
|
||||||
|
|
||||||
## 代理工作原则(铁律)
|
## 智能体工作原则(铁律)
|
||||||
|
|
||||||
1. 先理解目标与上下文,再动手改代码
|
1. 先理解目标与上下文,再动手改代码
|
||||||
2. 修改要小而清晰;避免无关重构
|
2. 修改要小而清晰;避免无关重构
|
||||||
|
|||||||
@@ -1,13 +1,13 @@
|
|||||||
# TypeScript 代理规则集
|
# TypeScript 智能体规则集
|
||||||
|
|
||||||
本规则集定义 AI/自动化代理在处理 TypeScript/JavaScript 代码时必须遵守的核心约束。
|
本规则集定义 AI/自动化智能体在处理 TypeScript/JavaScript 代码时必须遵守的核心约束。
|
||||||
|
|
||||||
## 范围与优先级
|
## 范围与优先级
|
||||||
|
|
||||||
- 作为仓库级基线规则集使用;更靠近代码目录的规则更具体并可覆盖基线。
|
- 作为仓库级基线规则集使用;更靠近代码目录的规则更具体并可覆盖基线。
|
||||||
- 当代理规则与 docs 冲突:安全/合规优先,其次保持仓库一致性。
|
- 当智能体规则与 docs 冲突:安全/合规优先,其次保持仓库一致性。
|
||||||
|
|
||||||
## 代理工作原则(铁律)
|
## 智能体工作原则(铁律)
|
||||||
|
|
||||||
1. 先理解目标与上下文,再动手改代码
|
1. 先理解目标与上下文,再动手改代码
|
||||||
2. 修改要小而清晰;避免无关重构
|
2. 修改要小而清晰;避免无关重构
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
# 代理指引
|
# 智能体指引
|
||||||
|
|
||||||
<!-- playbook:framework:start -->
|
<!-- playbook:framework:start -->
|
||||||
|
|
||||||
|
|||||||
+3
-3
@@ -1,6 +1,6 @@
|
|||||||
# 项目架构模板
|
# 项目架构模板
|
||||||
|
|
||||||
本目录包含基于 superpowers 工作流的项目模板,用于快速初始化 AI 代理工作环境。
|
本目录包含基于 superpowers 工作流的项目模板,用于快速初始化 AI 智能体工作环境。
|
||||||
|
|
||||||
## 与 Playbook 其他部分的关系
|
## 与 Playbook 其他部分的关系
|
||||||
|
|
||||||
@@ -62,7 +62,7 @@ templates/
|
|||||||
|
|
||||||
- `docs/prompts/custom/` 和项目新增的 `docs/prompts/**/*` 不会被 playbook 删除
|
- `docs/prompts/custom/` 和项目新增的 `docs/prompts/**/*` 不会被 playbook 删除
|
||||||
- `CLAUDE.md` 如已有 playbook 区块则更新;如未引用 `@AGENTS.md` 则追加;如已手工引用则跳过
|
- `CLAUDE.md` 如已有 playbook 区块则更新;如未引用 `@AGENTS.md` 则追加;如已手工引用则跳过
|
||||||
- 流程约束统一收敛到 `AGENT_RULES.md`;`docs/prompts/` 只负责把代理导向正确的任务入口
|
- 流程约束统一收敛到 `AGENT_RULES.md`;`docs/prompts/` 只负责把智能体导向正确的任务入口
|
||||||
|
|
||||||
## 部署方式
|
## 部署方式
|
||||||
|
|
||||||
@@ -138,7 +138,7 @@ templates/
|
|||||||
|
|
||||||
**生命周期**:
|
**生命周期**:
|
||||||
|
|
||||||
- `docs/prompts/`:任务入口层,只负责把代理导向正确入口
|
- `docs/prompts/`:任务入口层,只负责把智能体导向正确入口
|
||||||
- `docs/superpowers/specs/`:设计稿
|
- `docs/superpowers/specs/`:设计稿
|
||||||
- `docs/superpowers/plans/`:实施计划与主执行输入
|
- `docs/superpowers/plans/`:实施计划与主执行输入
|
||||||
- `memory-bank/progress.md`:执行状态留痕
|
- `memory-bank/progress.md`:执行状态留痕
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# 提示词入口
|
# 提示词入口
|
||||||
|
|
||||||
本目录包含 AI 代理的任务入口模板,用于把任务路由到合适的执行路径。
|
本目录包含 AI 智能体的任务入口模板,用于把任务路由到合适的执行路径。
|
||||||
它是薄入口层,不是流程权威;完整流程与执行约束只在
|
它是薄入口层,不是流程权威;完整流程与执行约束只在
|
||||||
`AGENT_RULES.md` 定义。
|
`AGENT_RULES.md` 定义。
|
||||||
|
|
||||||
@@ -45,7 +45,7 @@ prompts/
|
|||||||
> `coding/` 下是可被框架覆盖更新的标准入口模板;
|
> `coding/` 下是可被框架覆盖更新的标准入口模板;
|
||||||
> 项目私有补充入口应沉淀到 `custom/`。
|
> 项目私有补充入口应沉淀到 `custom/`。
|
||||||
>
|
>
|
||||||
> `prompts/` 只负责把代理导向正确入口;`AGENT_RULES.md`
|
> `prompts/` 只负责把智能体导向正确入口;`AGENT_RULES.md`
|
||||||
> 是唯一流程权威;`AGENT_RULES.local.md` 保存项目私有规则;
|
> 是唯一流程权威;`AGENT_RULES.local.md` 保存项目私有规则;
|
||||||
> `memory-bank/` 保存项目上下文与状态;`docs/superpowers/`
|
> `memory-bank/` 保存项目上下文与状态;`docs/superpowers/`
|
||||||
> 保存设计与计划产物。
|
> 保存设计与计划产物。
|
||||||
|
|||||||
Reference in New Issue
Block a user