📝 docs(templates): add execution and memory-bank prompt templates
This commit is contained in:
@@ -0,0 +1,60 @@
|
||||
# 收尾模板
|
||||
|
||||
<!--
|
||||
用途:一轮实现或一个 Plan 结束后做收尾
|
||||
触发:准备结束当前任务、切换上下文、交付结果前
|
||||
-->
|
||||
|
||||
## 目标
|
||||
|
||||
确认当前任务已经形成可交付结果,并把后续工作所需的信息留痕。
|
||||
|
||||
## 执行步骤
|
||||
|
||||
### 1. 核对结果
|
||||
|
||||
- 已完成哪些改动?
|
||||
- 哪些内容仍未完成?
|
||||
- 是否存在阻塞、风险或待确认事项?
|
||||
|
||||
### 2. 核对验证
|
||||
|
||||
- 已运行哪些验证?
|
||||
- 哪些验证未运行,原因是什么?
|
||||
- 当前结果是否满足本轮交付标准?
|
||||
|
||||
### 3. 核对状态留痕
|
||||
|
||||
- `main_loop.py finish` 是否已经写回 `plan-status`
|
||||
- `workflow-state.phase` 是否与当前结果一致
|
||||
- 如为代码类执行,`workflow-state` 中是否保留了
|
||||
`executor=executing-plans` 与既定 `constraints`
|
||||
|
||||
### 4. 回写上下文
|
||||
|
||||
- 需要写入 `memory-bank/active-context.md` 的信息
|
||||
- 需要写入 `memory-bank/progress.md` 上半部分摘要
|
||||
- 需要写入 `memory-bank/decisions.md` 的关键决策
|
||||
|
||||
### 5. 输出收尾摘要
|
||||
|
||||
```markdown
|
||||
## 本轮结果
|
||||
|
||||
- 已完成:...
|
||||
- 未完成:...
|
||||
- 验证:...
|
||||
- 风险 / 待确认:...
|
||||
- 下一步:...
|
||||
```
|
||||
|
||||
## 原则
|
||||
|
||||
- 只写对下一轮仍然重要的信息
|
||||
- 未验证的内容必须显式说明
|
||||
- 如果任务状态变更,优先通过 `main_loop.py finish` 留痕
|
||||
- 不手工改写 `workflow-state` 或 `plan-status` 状态块
|
||||
|
||||
---
|
||||
|
||||
**最后更新**:{{DATE}}
|
||||
@@ -0,0 +1,79 @@
|
||||
# 回写记忆模板
|
||||
|
||||
<!--
|
||||
用途:在任务完成、方向切换或发现新规律后更新 memory-bank
|
||||
触发:完成一轮实现、形成新决策、当前焦点变化时
|
||||
-->
|
||||
|
||||
## 什么时候需要回写
|
||||
|
||||
- 当前目标已经变化
|
||||
- 最近改动会影响下一轮判断
|
||||
- 发现新的系统模式或约束
|
||||
- 做出了值得保留的决策
|
||||
|
||||
## 回写路径
|
||||
|
||||
### `memory-bank/active-context.md`
|
||||
|
||||
更新:
|
||||
|
||||
- 当前目标
|
||||
- 最近变更
|
||||
- touched files
|
||||
- 下一步
|
||||
|
||||
### `memory-bank/progress.md`
|
||||
|
||||
更新:
|
||||
|
||||
- 先读取 `workflow-state`:当前阶段、spec、plan、executor、constraints
|
||||
- 再读取 `plan-status`:当前 Plan 的机器状态
|
||||
- Current Focus
|
||||
- Recent Changes
|
||||
- Next Steps
|
||||
- Open Risks
|
||||
|
||||
只更新上半部分的人类摘要,不修改状态块。
|
||||
|
||||
推荐写法:
|
||||
|
||||
- `Current Focus`:当前阶段结束后,项目现在最重要的工作
|
||||
- `Recent Changes`:本轮实际完成的变更、写回的状态、关键验证结果
|
||||
- `Next Steps`:下一轮最自然的 1-3 个动作
|
||||
- `Open Risks`:仍未解决的阻塞、环境约束、待确认事项
|
||||
|
||||
禁止:
|
||||
|
||||
- 手工改写 `<!-- workflow-state:start/end -->`
|
||||
- 手工改写 `<!-- plan-status:start/end -->`
|
||||
- 把临时聊天内容、未验证猜测写进摘要
|
||||
|
||||
### `memory-bank/decisions.md`
|
||||
|
||||
仅在出现重要决策时记录 ADR:
|
||||
|
||||
- 为什么这样做
|
||||
- 备选方案是什么
|
||||
- 影响范围是什么
|
||||
|
||||
### `memory-bank/system-patterns.md`
|
||||
|
||||
仅在发现稳定模式时更新:
|
||||
|
||||
- 模块边界
|
||||
- 不变量
|
||||
- 扩展路径
|
||||
- 禁止破坏的约束
|
||||
|
||||
## 原则
|
||||
|
||||
- 只回写长期有价值的信息
|
||||
- 临时聊天内容不要写进去
|
||||
- 高变化信息放 `active-context`,稳定约束放 `system-patterns`
|
||||
- `progress.md` 的状态块只由 `main_loop.py` 维护
|
||||
- 摘要应与 `workflow-state` / `plan-status` 保持一致
|
||||
|
||||
---
|
||||
|
||||
**最后更新**:{{DATE}}
|
||||
@@ -0,0 +1,68 @@
|
||||
# 变更验证模板
|
||||
|
||||
<!--
|
||||
用途:在声明“完成 / 修复 / 可交付”前,明确验证范围与证据
|
||||
触发:代码修改、配置修改、模板修改、规则修改后
|
||||
-->
|
||||
|
||||
## 验证目标
|
||||
|
||||
- 这次改动要证明什么?
|
||||
- 哪些行为必须通过?
|
||||
- 哪些验证本轮不做?
|
||||
|
||||
## 验证步骤
|
||||
|
||||
### 1. 语法 / 结构检查
|
||||
|
||||
- 确认修改文件可读、可解析、无明显结构错误
|
||||
|
||||
### 2. 定向验证
|
||||
|
||||
- 只跑与本次改动直接相关的验证命令
|
||||
- 记录命令、结果和关键输出
|
||||
|
||||
```bash
|
||||
{{VERIFY_CMD}}
|
||||
```
|
||||
|
||||
### 3. 差异复核
|
||||
|
||||
- 核对 diff 是否只包含预期修改
|
||||
- 确认没有误删、误改、命名漂移或路径漂移
|
||||
|
||||
### 4. 状态留痕复核
|
||||
|
||||
- `workflow-state.phase` 是否与当前声明一致
|
||||
- `plan-status` 是否已经通过 `main_loop.py finish` 写回
|
||||
- 如为代码类任务,`workflow-state` 中是否保留:
|
||||
`executor=executing-plans`
|
||||
`constraints=karpathy-guidelines,.agents,AGENT_RULES`
|
||||
|
||||
### 5. 剩余风险
|
||||
|
||||
- 本轮未覆盖的验证
|
||||
- 环境限制
|
||||
- 需要人工确认的点
|
||||
|
||||
## 输出格式
|
||||
|
||||
```markdown
|
||||
## 验证结果
|
||||
|
||||
- 已验证:...
|
||||
- 证据:...
|
||||
- 未验证:...
|
||||
- 风险:...
|
||||
```
|
||||
|
||||
## 原则
|
||||
|
||||
- 没有证据,不宣称完成
|
||||
- 局部修改优先局部验证
|
||||
- 不能运行的验证要明确写原因
|
||||
- 不手工改写 `workflow-state` 或 `plan-status` 状态块
|
||||
|
||||
---
|
||||
|
||||
**最后更新**:{{DATE}}
|
||||
Reference in New Issue
Block a user