跳到正文
教程31 篇

Codex CLI第 1 / 4 篇

先让 Codex 看懂任务,再拆解复杂改动

用一个设置页改造,学会描述结果、收敛范围和安排验证。

入门约 8 分钟练习资料核实

学习目标

得到一份对应真实仓库、可实施也可验收的改动计划。

流程示意从任务说明到可验收改动
  1. 目标与边界

    写清成功后用户看到什么,以及哪些现有行为必须保留。

  2. 只读探索

    让 Codex 先引用真实组件、状态与测试,而不是凭想象设计架构。

  3. 小步计划

    一次只交付一个能单独验收的改动,并列出涉及文件。

  4. 差异与验证

    对照原目标检查实际结果,未运行的检查单独说明。

四个节点对应正文的操作步骤;每一步都应留下可核对的信息。

适用场景

准备给已有设置页增加表单校验,但还不清楚表单状态、接口错误和保存按钮之间的关系。跨文件改动先探索;范围已经明确的小修改可以直接实现并验证。

准备条件

  • 可正常打开的代码仓库,已在 Codex 中选择该项目。
  • 一个具体目标,以及需要保留的现有行为。

操作步骤

  1. 先描述成功后的样子

    不要只说“优化一下”。说明谁在做什么、当前哪里不顺,以及什么结果才算完成;同时交代需要保留的行为。

    任务说明示例
    目标:设置页保存前校验必填项。
    保留:现有接口、页面布局和保存成功后的跳转。
    验收:空值显示提示;合法输入可保存;接口失败保留已输入内容。
  2. 允许只读探索,再要一份短计划

    让 Codex 依据现有代码定位组件、状态与测试,不要凭想象直接指定新架构。计划应列出涉及文件和未知点。

    可复制提示词
    先查看适用的项目指引和相关实现,允许必要的只读检查。
    请给出最小改动计划、涉及文件、需要澄清的问题和验证方法。
    本轮先不修改文件。
  3. 把计划压缩成可交付的小步

    一次只解决一个目标。将“前端做完”换成“必填校验和错误保留都可验证”。官方 Cookbook 中的 PLANS.md 等是工作流示例,不是每个项目必备的文件。

  4. 实现后对照原目标验收

    进入实施时沿用已明确的范围。检查实际差异和真实运行结果;若某项检查未运行,应保留原因,而不是把“应该可以”写成通过。

    实施与验收提示词
    按计划完成这一项改动,并执行项目已有的相关检查。
    最后说明:改了什么、每项验收的实际结果、未完成或未运行的部分。

常见误区

一次要求重做整个设置系统
先选一个能单独验收的改动,再决定下一步。
计划写得很长,却没有验收办法
为每个步骤补上可观察结果,例如输入为空时页面具体显示什么。

验收清单

  • 计划引用了仓库中真实存在的组件或文件。
  • 空值、合法输入和接口失败三种情况各有验证方法。
  • 最后的通过结论来自实际检查,未运行项明确列出。

资料与版本

本文为原创整理,示例需按项目调整;工具界面与功能以当前版本为准。