📝 docs(templates): refine superpowers prompt boundaries
This commit is contained in:
+35
-29
@@ -1,14 +1,15 @@
|
||||
# 项目架构模板
|
||||
|
||||
本目录包含项目架构的模板文件,用于快速初始化新项目的 AI 代理工作环境。
|
||||
本目录包含以 `superpowers` 为基石的项目模板,用于快速初始化新项目的
|
||||
AI 代理工作环境。
|
||||
|
||||
## 目录结构
|
||||
|
||||
```text
|
||||
templates/
|
||||
├── README.md # 本文件
|
||||
├── AGENTS.template.md # 路由中心模板
|
||||
├── AGENT_RULES.template.md # 执行流程模板
|
||||
├── AGENTS.template.md # 入口导航模板
|
||||
├── AGENT_RULES.template.md # superpowers-first 执行规则模板
|
||||
├── memory-bank/ # 项目上下文模板
|
||||
│ ├── project-brief.template.md
|
||||
│ ├── tech-context.template.md
|
||||
@@ -16,7 +17,7 @@ templates/
|
||||
│ ├── active-context.template.md
|
||||
│ ├── progress.template.md
|
||||
│ └── decisions.template.md
|
||||
├── prompts/ # 提示词库模板
|
||||
├── prompts/ # 任务入口模板(不是流程权威)
|
||||
│ ├── README.md
|
||||
│ ├── system/
|
||||
│ │ └── agent-behavior.template.md
|
||||
@@ -48,6 +49,7 @@ templates/
|
||||
|
||||
- **会同步更新的框架模板**
|
||||
- `AGENT_RULES.md`
|
||||
- `docs/prompts/README.md`
|
||||
- `docs/prompts/system/*.md`
|
||||
- `docs/prompts/coding/*.md`
|
||||
- `AGENTS.md`、`CLAUDE.md`(按 playbook 区块更新)
|
||||
@@ -69,6 +71,8 @@ templates/
|
||||
不会被 playbook 删除。
|
||||
- `CLAUDE.md` 如已有 playbook 区块则更新;如未引用
|
||||
`@AGENTS.md` 则追加;如已手工引用 `@AGENTS.md` 则跳过。
|
||||
- 流程约束统一收敛到 `AGENT_RULES.md`;`docs/prompts/`
|
||||
只负责把代理导向正确的任务入口。
|
||||
|
||||
## 快速部署
|
||||
|
||||
@@ -158,6 +162,12 @@ force = true
|
||||
|
||||
### docs/superpowers 命名约定
|
||||
|
||||
`docs/superpowers/` 统一承载设计稿和实施计划:
|
||||
|
||||
- 设计只落到 `specs/`
|
||||
- 计划只落到 `plans/`
|
||||
- 执行状态只写回 `memory-bank/progress.md`
|
||||
|
||||
为与 thirdparty `superpowers` 上游当前工作流对齐,建议统一使用:
|
||||
|
||||
- `docs/superpowers/specs/YYYY-MM-DD-<topic>-design.md`:
|
||||
@@ -169,28 +179,20 @@ force = true
|
||||
|
||||
### 生命周期总览
|
||||
|
||||
```text
|
||||
需求澄清
|
||||
-> using-superpowers
|
||||
-> brainstorming
|
||||
-> docs/superpowers/specs/*.md
|
||||
-> playbook.py -record-spec
|
||||
-> writing-plans
|
||||
-> docs/superpowers/plans/*.md
|
||||
-> playbook.py -record-plan
|
||||
-> main_loop.py claim
|
||||
-> executing-plans
|
||||
-> [代码类任务] + karpathy-guidelines + .agents + AGENT_RULES
|
||||
-> main_loop.py finish
|
||||
-> update-memory / close-task
|
||||
```
|
||||
完整主链只在 `AGENT_RULES.template.md` 定义;本文件不重复展开。
|
||||
这里仅说明职责分层:
|
||||
|
||||
- `docs/prompts/`:任务入口层,只负责把代理导向正确入口
|
||||
- `docs/superpowers/specs/`:设计稿
|
||||
- `docs/superpowers/plans/`:实施计划与主执行输入
|
||||
- `memory-bank/progress.md`:执行状态留痕
|
||||
|
||||
### 部署后的目录结构
|
||||
|
||||
```text
|
||||
project/
|
||||
├── AGENTS.md # 路由中心(Codex 入口)
|
||||
├── AGENT_RULES.md # 执行流程
|
||||
├── AGENTS.md # 入口导航(Codex 入口)
|
||||
├── AGENT_RULES.md # superpowers-first 执行规则
|
||||
├── AGENT_RULES.local.md # 项目私有规则(自动创建,项目维护)
|
||||
├── CLAUDE.md # Claude Code 入口(按规则维护/追加 playbook 区块)
|
||||
├── memory-bank/ # 项目上下文
|
||||
@@ -201,7 +203,7 @@ project/
|
||||
│ ├── progress.md
|
||||
│ └── decisions.md
|
||||
└── docs/
|
||||
├── prompts/ # 提示词库
|
||||
├── prompts/ # 任务入口层
|
||||
│ ├── README.md
|
||||
│ ├── system/agent-behavior.md
|
||||
│ └── coding/
|
||||
@@ -251,33 +253,37 @@ project/
|
||||
|
||||
### prompts/
|
||||
|
||||
工作流程模板(部署后去掉 `.template` 后缀):
|
||||
任务入口模板(部署后去掉 `.template` 后缀):
|
||||
|
||||
其中 `templates/prompts/README.md` 部署后对应 `docs/prompts/README.md`,
|
||||
作为任务入口索引。
|
||||
|
||||
| 文件 | 用途 | 使用场景 |
|
||||
| ----------------------------------- | ------------ | ------------------- |
|
||||
| `system/agent-behavior.template.md` | 工作流入口 | 选择执行路径 |
|
||||
| `system/agent-behavior.template.md` | 入口路由模板 | 选择执行路径 |
|
||||
| `coding/clarify.template.md` | 需求澄清模板 | 需求不明确时 |
|
||||
| `coding/verify-change.template.md` | 变更验证模板 | 声称完成前验证 |
|
||||
| `coding/close-task.template.md` | 本轮收尾模板 | 一轮工作结束时 |
|
||||
| `coding/update-memory.template.md` | 回写记忆模板 | 上下文变化后回写 |
|
||||
| `coding/code-review.template.md` | 代码评审流程 | 执行 MR/PR 代码评审 |
|
||||
| `coding/code-review.template.md` | 代码评审入口 | 执行 MR/PR 代码评审 |
|
||||
|
||||
### AGENT_RULES.template.md
|
||||
|
||||
执行流程规范,定义 AI 的工作循环和约束。
|
||||
执行规则模板,定义 AI 的工作循环和约束。
|
||||
如需项目私有规则,建议维护 `AGENT_RULES.local.md`;该文件通常由 `[sync_rules]`
|
||||
首次自动创建,其优先级高于 `AGENT_RULES.md`,且后续不会被 `playbook.py` 覆盖。
|
||||
计划编排与执行细节建议放在 `prompts/README.md` 或相关 workflow 文档中,
|
||||
计划编排与执行细节统一指向 `docs/superpowers/`、
|
||||
`playbook.py -record-spec/-record-plan` 与 `main_loop.py claim/finish`;
|
||||
这里仅说明模板职责与部署边界。
|
||||
|
||||
### AGENTS.template.md
|
||||
|
||||
路由中心模板,作为项目的主入口。
|
||||
入口导航模板,作为项目的主入口。
|
||||
|
||||
**设计理念**:
|
||||
|
||||
- **最小化内容**:只包含导航链接,不包含详细规则
|
||||
- **结构化导航**:分为核心规则、项目上下文、工作流程三个板块
|
||||
- **结构化导航**:分为核心规则、项目上下文、任务入口三个板块
|
||||
|
||||
**playbook 标记**(用于自动更新):
|
||||
|
||||
|
||||
Reference in New Issue
Block a user