第 62 卷

修改接口API 文档

修改部署流程部署说明

修改配置配置说明

新增组件组件使用说明

文档更新不是为了好看，而是为了避免以后忘记。

常见文档包括：

文件作用

提交与复盘提示词模板

实际使用时，可以直接复制下面这段：

请按下面结构输出：

1. Commit 建议

• 生成一个合适的 commit message
• 使用 conventional commit 格式
• 不要夸大本次修改范围

1. PR 描述

请生成 PR 内容，包括：

• 本次修改
• 修改原因
• 涉及文件
• 测试结果
• 风险说明
• reviewer 需要重点看的地方

1. 问题记录

请复盘本次过程：

• 遇到了哪些问题
• 原因是什么
• 如何解决
• 下次如何避免

1. Prompt 总结

请总结：

• 哪些 Prompt 有效
• 为什么有效
• 适合什么场景复用
• 是否建议加入 AGENTS.md

1. AGENTS.md 更新建议

请输出适合加入 AGENTS.md 的长期规则：

• 修改前规则
• 修改中规则
• 测试规则
• 提交规则

• docs/
• CHANGELOG.md
• 其他项目文档

最后请给出交付结论：

• 是否可以提交
• 是否可以发 PR
• 是否还有未完成事项
• 是否有需要人工确认的风险

Codex 任务模板库

前面讲的是 Codex 的标准工作流。

这一节直接放一些常用模板，方便以后复制使用。

这些模板的作用是：

不用每次重新想 Prompt，直接按场景复制，然后填入自己的需求。

读项目模板

这个模板适合在刚打开一个新项目时使用。

尤其是你第一次让 Codex 接触某个项目，不要一上来就让它改代码。

更稳的方式是：先让它读项目，输出一份项目理解报告。

这样你可以先判断：

检查点作用