📝 docs(templates): add execution and memory-bank prompt templates
This commit is contained in:
@@ -0,0 +1,48 @@
|
||||
# 当前上下文
|
||||
|
||||
<!--
|
||||
填写指南:
|
||||
- 本文件记录高频变化的上下文,供 AI 在跨 Session 时快速恢复工作状态
|
||||
- 保持简洁,只写“现在仍然重要”的信息
|
||||
- 任务完成或方向切换后及时更新
|
||||
-->
|
||||
|
||||
## Current Goal
|
||||
|
||||
<!-- 当前最重要的目标;一句话即可 -->
|
||||
|
||||
- {{CURRENT_GOAL}}
|
||||
|
||||
## Recent Changes
|
||||
|
||||
<!-- 最近完成且会影响后续判断的变更 -->
|
||||
|
||||
- {{RECENT_CHANGE_1}}
|
||||
|
||||
## Touched Files
|
||||
|
||||
<!-- 最近修改或正在关注的关键文件 -->
|
||||
|
||||
- `{{FILE_1}}` - {{FILE_1_REASON}}
|
||||
|
||||
## Open Questions
|
||||
|
||||
<!-- 尚未确认、但会影响实现或验证的事项 -->
|
||||
|
||||
- {{QUESTION_1}}
|
||||
|
||||
## Next Steps
|
||||
|
||||
<!-- 接下来最优先的 1-3 步 -->
|
||||
|
||||
1. {{NEXT_STEP_1}}
|
||||
|
||||
## Session Notes
|
||||
|
||||
<!-- 只记录本轮最容易忘的上下文 -->
|
||||
|
||||
- {{SESSION_NOTE_1}}
|
||||
|
||||
---
|
||||
|
||||
**最后更新**:{{DATE}}
|
||||
@@ -0,0 +1,60 @@
|
||||
# 系统模式与约束
|
||||
|
||||
<!--
|
||||
填写指南:
|
||||
- 本文件记录跨模块稳定成立的实现模式,而不是一次性的设计草图
|
||||
- 优先记录:模块边界、数据流、不变量、扩展路径、禁止破坏的约束
|
||||
- 小项目可只保留最关键的 2-3 个部分
|
||||
-->
|
||||
|
||||
## 模块边界
|
||||
|
||||
<!-- 至少列出主要模块及其职责边界 -->
|
||||
|
||||
### {{MODULE_1}}
|
||||
|
||||
- **职责**:{{MODULE_1_DESC}}
|
||||
- **输入**:{{MODULE_1_INPUT}}
|
||||
- **输出**:{{MODULE_1_OUTPUT}}
|
||||
- **不应负责**:{{MODULE_1_NON_GOAL}}
|
||||
|
||||
## 关键数据流
|
||||
|
||||
<!-- 描述系统中的主路径;按“输入 -> 处理 -> 输出”写 -->
|
||||
|
||||
1. {{FLOW_STEP_1}}
|
||||
2. {{FLOW_STEP_2}}
|
||||
3. {{FLOW_STEP_3}}
|
||||
|
||||
## 核心不变量
|
||||
|
||||
<!-- 这些约束一旦被破坏,系统行为就可能失真 -->
|
||||
|
||||
- {{INVARIANT_1}}
|
||||
|
||||
## 常见实现模式
|
||||
|
||||
<!-- 给 AI 明确“这里通常怎么改” -->
|
||||
|
||||
### {{PATTERN_1}}
|
||||
|
||||
- **适用场景**:{{PATTERN_1_SCENARIO}}
|
||||
- **推荐做法**:{{PATTERN_1_APPROACH}}
|
||||
- **避免事项**:{{PATTERN_1_AVOID}}
|
||||
|
||||
## 扩展路径
|
||||
|
||||
<!-- 新增功能时,优先走哪些入口或目录 -->
|
||||
|
||||
1. {{EXTENSION_STEP_1}}
|
||||
2. {{EXTENSION_STEP_2}}
|
||||
|
||||
## 禁止破坏的约束
|
||||
|
||||
<!-- 记录兼容性、安全性或组织层面的硬约束 -->
|
||||
|
||||
- {{DO_NOT_BREAK_1}}
|
||||
|
||||
---
|
||||
|
||||
**最后更新**:{{DATE}}
|
||||
@@ -0,0 +1,72 @@
|
||||
# 技术上下文与工具链
|
||||
|
||||
<!--
|
||||
填写指南:
|
||||
- 本文件记录“如何在这个仓库里安全工作”
|
||||
- 优先填写命令、环境、入口路径、依赖限制
|
||||
- 未填写的占位符保持原样或删除整行
|
||||
-->
|
||||
|
||||
## 核心技术
|
||||
|
||||
<!-- 【必填】项目主要语言、框架、运行时 -->
|
||||
|
||||
- {{TECH_1}}
|
||||
|
||||
## 项目结构
|
||||
|
||||
<!-- 【必填】至少列出关键目录 -->
|
||||
|
||||
```text
|
||||
{{PROJECT_NAME}}/
|
||||
├── {{DIR_1}}/ # {{DIR_1_DESC}}
|
||||
└── memory-bank/ # 项目上下文
|
||||
```
|
||||
|
||||
## 关键入口
|
||||
|
||||
<!-- 【必填】AI 最常用的入口文件、命令或目录 -->
|
||||
|
||||
- `{{ENTRY_PATH_1}}` - {{ENTRY_PATH_1_DESC}}
|
||||
|
||||
## 开发环境
|
||||
|
||||
<!-- 【必填】至少填写验证相关命令 -->
|
||||
|
||||
**必需工具**:
|
||||
|
||||
- {{TOOL_1}}
|
||||
|
||||
**运行测试**:
|
||||
|
||||
```bash
|
||||
{{TEST_CMD}}
|
||||
```
|
||||
|
||||
**格式化 / Lint**:
|
||||
|
||||
```bash
|
||||
{{FORMAT_OR_LINT_CMD}}
|
||||
```
|
||||
|
||||
## 环境与平台差异
|
||||
|
||||
<!-- 【可选】如 Windows/Linux/macOS 行为不同,写在这里 -->
|
||||
|
||||
- {{ENV_DIFF_1}}
|
||||
|
||||
## 依赖与限制
|
||||
|
||||
<!-- 【可选】外部服务、私有依赖、危险命令、慢命令 -->
|
||||
|
||||
- {{DEPENDENCY_OR_LIMIT_1}}
|
||||
|
||||
## 验证约定
|
||||
|
||||
<!-- 【可选】什么叫“验证通过” -->
|
||||
|
||||
- {{PASS_CONDITION_1}}
|
||||
|
||||
---
|
||||
|
||||
**最后更新**:{{DATE}}
|
||||
Reference in New Issue
Block a user