提示词模板写好 Codex 提示词
交代目标、资料、边界和验收方式
- 任务目标做什么
- 上下文看哪些材料
- 操作限制哪些地方先确认
- 验收方式怎样算完成
把验收方式写进请求,便于最后逐项核对。
把任务交代完整:一个可复用的提示词骨架
01目标希望发生什么变化?
02上下文相关目录、代码、报错或用户场景
03边界哪些行为、接口或文件要保留?
04验收什么结果算完成?
05验证希望检查哪些测试、页面或差异?
目标+上下文+边界+验收标准+验证方式=更清楚的任务
先复制这一条,再替换方括号内容
这是一条通用起点。小任务可以删掉不适用的部分;碰到陌生代码或高风险改动时,先让 Codex 调查和列计划,再开始修改。
通用模板:请在当前项目中完成【目标】。相关背景是【背景或用户问题】,优先查看【文件、目录或复现步骤】。请保留【必须兼容的行为或约束】。完成标准是【可观察的结果】。先检查相关代码并简要说明计划;实施后按项目现有方式验证,最后总结改动文件、验证结果和仍需我确认的事项。
一、先读懂项目
适合接手新仓库、定位入口,或先弄清一段代码如何工作。
01快速认识项目
先阅读项目的 README、AGENTS.md(如果存在)和主要配置文件。请用简洁的结构说明:项目用途、技术栈、启动方式、主要目录职责,以及最适合从哪里开始阅读。先不要修改任何文件;对不确定的结论标明依据或待确认点。
02追踪一个功能流程
请追踪【功能或用户操作】从入口到最终结果的完整流程。重点查看【页面、路由、函数或目录】。按调用顺序列出关键文件、函数和数据变化,并标注证据位置;先只做分析,不要改代码。
03解释一段陌生代码
请解释【文件路径或代码片段】的职责和工作方式。面向刚接手项目的开发者说明输入、输出、关键分支、外部依赖与容易误解的地方。请用项目里的实际名称举例;如果缺少上下文,指出还需要查看什么。
04确定修改边界
我准备处理【需求或问题】。请先调查项目中相关实现,列出最可能需要修改的文件、调用方、兼容性约束和需要验证的路径。说明你判断的依据,并给出一个尽量小的修改方案;暂时不要改文件。
二、开发一个功能
把用户行为、实现边界和验收方式一起说明。
05实现一项功能
请实现【功能】。用户会【操作】,预期看到【结果】。相关位置是【页面或目录】;请沿用项目现有的组件、命名和错误处理方式,不引入不必要的新依赖。完成标准:1)【验收项】;2)【验收项】;3)保留【兼容要求】。完成后说明改动并运行相关验证。
06按界面需求调整页面
请调整【页面或组件】,让它符合以下视觉和交互要求:【描述布局、层级、文案、状态和响应式行为】。先查看现有样式与相邻页面,保持站点的设计语言。请覆盖加载、空数据、错误和窄屏状态;如果要求与现有结构冲突,先说明取舍。
07接入接口或数据
请在【页面或模块】接入【接口或数据源】。字段含义为【字段说明】,需要展示【内容】。沿用项目已有的请求封装和状态管理,处理加载、成功、空数据与失败状态。请勿把密钥写入源码;先检查接口约定和调用方,再实现并说明验证方式。
08先计划再分步实现
我要完成【跨多个文件的需求】。先不要动文件,请检查仓库并给出分步骤计划:每步目标、涉及文件、主要风险和验证方法。把不确定事项与需要我决定的选项列出来。等计划清楚后,再按小步实现,每步完成都汇报进展。
三、定位并修复问题
先收集证据,区分原因和症状,再选择最小修复。
09从复现步骤开始排查
问题表现:【描述】。复现步骤:【步骤】。预期结果:【预期】,实际结果:【实际】。相关环境或版本:【信息】。请先检查相关代码和日志,提出最可能的原因及证据,再给出验证假设的步骤;确认原因前不要直接大范围改动。
10修复一个明确 Bug
请修复【具体 Bug】,复现方式是【步骤或命令】,目前表现为【实际】,应当表现为【预期】。请找到根因,优先做范围最小的修复,不改变无关行为;为回归场景补充或调整测试。完成后运行相关测试,并指出仍未覆盖的情况。
11读懂错误日志
请分析下面的错误信息,先用通俗语言解释它表示什么,再结合项目代码判断可能原因。请按“证据—假设—验证步骤”列出排查顺序,并区分确定事实与推测。错误日志:【粘贴已脱敏的日志】。暂时不要执行会删除数据或改变远程环境的操作。
12排查偶发问题
【问题】偶尔发生,暂时无法稳定复现。请梳理可能涉及的状态、并发、缓存、时序或环境差异。先从代码和现有日志找线索,提出一份区分不同假设的观测方案;需要加日志时,请说明位置、内容和隐私影响,再做最小修改。
四、补测试与验证质量
让“完成了”对应到可以复现的检查结果。
13为功能补充测试
请为【功能或模块】补充测试。先阅读项目当前的测试框架和相邻测试,覆盖正常路径、边界输入和失败情形;避免只断言实现细节。先说明计划覆盖的场景,再添加测试并运行相关测试,报告命令和结果。
14解释现有测试失败
以下测试失败:【测试名称或输出】。请定位失败断言对应的行为,检查最近相关代码和测试设置,判断是产品缺陷、测试过时还是环境问题。先给证据和最小修正建议;如果修改,请保留原本要保护的行为并运行相关测试。
15选择合适的验证命令
我改动了【文件或功能】。请查看项目脚本和说明,推荐最相关、成本合适的验证命令,说明每条命令检查什么。先运行与改动匹配的检查;若某条检查无法运行,请说明阻塞原因,不要把未运行写成通过。
16列出边界测试清单
针对【功能】设计边界测试清单。考虑空值、极端值、重复提交、权限不足、网络失败、状态切换和窄屏(按项目适用情况取舍)。用“输入或操作|预期结果|自动化还是人工检查”表格输出,并指出最容易漏掉的高风险场景。
五、审查与整理代码
优先发现会造成错误、回归或后续维护困难的问题。
17审查当前代码差异
请审查当前工作区相对基线的代码差异,重点找真实缺陷、回归风险、数据丢失和缺失测试。不要重写代码;按严重程度列出问题,每项写明文件与位置、触发条件、影响和依据。若没有发现问题,也请列出检查范围和未验证的部分。
18安全地重构一小段
请整理【模块或函数】,目标是【提升可读性或减少重复】。保持现有外部行为、接口和格式约定,不增加新依赖。先说明计划并确认已有测试能覆盖哪些行为,再分小步重构;完成后比较差异并运行相关验证。
19检查常见安全风险
请对【功能或改动】做一次防御性安全检查,关注输入校验、权限边界、敏感信息、注入风险和错误信息泄露。只报告能从代码或配置中支持的发现,说明可能影响与修复方向;不要尝试访问真实账号、外部系统或生产数据。
20调查性能瓶颈
【操作】在【环境或数据规模】下变慢。请先找到可观测证据,例如重复计算、慢查询、过大渲染或多余网络请求。列出假设和测量方法,再建议优先级最高的小改动;没有基准数据时请先说明怎样建立基线,不要只凭感觉重写。
六、文档与任务交接
把解决方案沉淀下来,让后续使用者能接着做。
21按代码更新 README
请检查【功能或命令】的当前实现与 README,更新与实际行为一致的说明,包括使用场景、操作步骤、输入输出和已知限制。保留原文中仍然准确的内容;不要臆造尚未实现的能力。完成后列出新增或修改的小节。
22写一份故障处理手册
请根据项目已有配置、日志和运维说明,为【服务或功能】整理故障排查手册:现象、初步检查、常见原因、无破坏性的验证步骤、升级处理条件和回滚注意事项。只写仓库或我提供的资料能够支持的内容,并标注待确认项。
23整理版本变更说明
请根据本次实际代码差异整理面向用户的版本说明。分为新增功能、修复问题、兼容性影响和需要用户操作的事项;用简洁语言写清效果,不暴露内部敏感信息。不要把计划中的改动写成已发布内容。
24生成可接手的完成报告
请为【任务】生成一份简明交接报告:目标与结果、主要改动文件、采用的实现方案、已运行的验证及准确结果、尚存限制、建议的后续步骤。区分已完成、未完成和需要我决定的事项;没有运行的检查请明确标为未运行。
把模板变成稳定的协作习惯
不用每次都写很长。先选一条最接近当前任务的模板,再补上项目名、文件路径、复现步骤和验收标准。Codex 的官方提示建议明确期望行为、相关代码或复现信息、重要约束和验证方式;项目长期规则则可以整理到 AGENTS.md,避免每次重复输入。
先给证据路径、报错、截图说明或最小复现,越具体越容易定位。
写清边界说明要保留什么、哪些文件不要动,以及是否先只分析。
核对结果查看差异、实际页面和验证输出,再决定是否接受改动。
隐私和高风险操作:粘贴日志前先移除密码、令牌和个人资料。删除数据、改远程服务、部署或产生费用的步骤,应要求先说明影响并等待你确认。