Codex 工作流
怎样给 Codex 准备一份可持续接手的项目交接文档
提供一份可直接复制的 Codex 项目交接模板,覆盖项目背景、技术栈、当前状态、已完成工作、待办、风险、运行命令和验收标准。新线程接手时只需阅读本模板即可快速进入状态。
更新时间:2026-06-26
适用对象:Codex 用户 / 独立开发者
可直接复制的交接模板
# 项目交接文档
## 1. 项目基本信息
- 项目名称:
- 项目目标:
- 目标用户:
- 当前版本:
- 当前阶段:
- 仓库路径:
- 部署地址:
- 最近更新时间:
## 2. 核心产品约束
- 必须保留的功能:
- 不允许修改的功能:
- UI 约束:
- 数据安全要求:
- 成本要求:
- 兼容性要求:
## 3. 技术栈
- 前端:
- 后端:
- 数据库:
- 部署:
- 包管理器:
- 测试框架:
- 关键第三方服务:
## 4. 项目结构
src/
public/
docs/
scripts/
tests/
## 5. 已完成功能
- [x] 功能一(对应文件、验收结果、已知限制)
- [x] 功能二
## 6. 当前进行中的工作
- 工作项:
- 当前进度:
- 修改文件:
- 尚未解决的问题:
- 下一步建议:
## 7. 待办清单
### P0
- [ ] 阻断性问题
### P1
- [ ] 重要增强
### P2
- [ ] 后续优化
## 8. 已知问题
| 问题 | 表现 | 可能原因 | 已尝试方案 | 当前状态 |
## 9. 运行与构建
pnpm install # 安装
pnpm dev # 开发
pnpm test # 测试
pnpm build # 构建
## 10. 环境变量
DATABASE_URL
OPENAI_API_KEY
PUBLIC_SITE_URL
## 11. 验收标准
- [ ] 构建成功
- [ ] 测试通过
- [ ] 核心功能正常
- [ ] UI 无明显偏移
- [ ] 移动端可用
- [ ] 无敏感信息泄露
- [ ] 文档已更新
## 12. 禁止事项
- 不得未经确认升级核心依赖
- 不得删除现有数据
- 不得重构与当前任务无关的模块
- 不得改变公开 URL
- 不得提交密钥
- 不得跳过构建和验收
## 13. 新线程接手提示词
请先阅读本交接文档、README、AGENTS.md 和最近提交记录。
开始工作前:
1. 总结你对项目现状的理解
2. 列出本次预计修改文件
3. 说明风险和回滚方式
4. 等待确认后再修改
5. 修改完成后运行测试和构建
6. 输出修改报告与剩余问题
AGENTS.md 配套建议
仓库根目录增加简洁版 AGENTS.md:
# AGENTS.md
## 项目原则
- 修改前先阅读 README 和 docs/project-handoff.md。
- 不重构与当前任务无关的代码。
- 不改变公开 URL 和数据结构,除非任务明确要求。
- 新增生产依赖前必须说明理由并获得确认。
- 修改完成后必须运行 lint、test 和 build。
- UI 修改必须检查桌面端和移动端。
- 不得提交 API Key、Cookie、认证文件或用户数据。
## 输出要求
每次任务完成后输出:
1. 修改文件
2. 修改内容
3. 测试结果
4. 风险
5. 回滚方法
6. 尚未完成的问题
注意:AGENTS.md 不要无限增长;只放长期稳定规则;具体阶段任务放到独立工程文档;子目录有特殊规则时,再增加局部 AGENTS.md。
实践建议
交接文档的实际使用场景
交接文档不是一次写完就束之高阁的。以下场景都值得更新交接文档:完成一个功能模块后(更新已完成清单)、遇到一个新的已知问题(加入问题表)、切换开发环境前(确保远程主机上的线程能快速接手)、Codex 版本更新后(更新相关配置和注意事项)。建议在每次 git commit 时顺手检查交接文档是否需要同步更新,养成习惯后只需要一两分钟。
从交接文档到 AGENTS.md 的演进路径
当你发现某些规则反复出现在多份交接文档中时(比如"不要跳过构建验证"、"不要修改公开 URL"),说明这些规则已经足够稳定,应该从交接文档中提取出来放入 AGENTS.md。交接文档记录的是当前状态(What's happening now),AGENTS.md 记录的是长期规则(Always follow these)。两条线并行维护,互不干扰。
FAQ
- Q:为什么需要项目交接文档?
A:Codex 每次新线程没有上下文记忆。一份好的交接文档能让新线程快速理解项目现状,减少重复沟通。 - Q:AGENTS.md 和交接文档有什么区别?
A:AGENTS.md 放长期稳定规则(原则),交接文档放当前阶段的具体信息(状态、进度、待办)。 - Q:交接文档应该放在哪里?
A:建议放在 docs/project-handoff.md 或项目根目录的 PROJECT_CONTEXT.md。