Skip to content

提示与工作流

Codex 的提示不需要花哨,但需要可执行。越是复杂的仓库,越要把任务拆成可理解、可验证、可审阅的小步。

基础提示结构

text
目标:
请在 docs/codex/ 下新增 Codex 最佳实践文档,并接入导航。

上下文:
这是 VitePress 文档站。已有 docs/workflow、docs/tools、docs/howto-zh 等栏目。
新增页面参考现有 Markdown frontmatter:title + order。

约束:
不要修改 node_modules、截图、压缩包。
内容必须基于 OpenAI 官方 Codex 文档和 openai/codex GitHub 仓库,不要编造命令。

完成标准:
npm run docs:build 通过。
最终说明新增文件、来源和验证结果。

任务拆分模式

1. 探索型

用于理解仓库、定位问题、规划迁移。

text
先只读项目。请总结目录结构、构建命令、已有文档规范,并列出你建议修改的文件。

2. 实现型

用于明确范围内的代码或文档修改。

text
按照刚才的计划实现。保持改动最小,遵循现有文档风格,完成后运行构建检查。

3. 审查型

用于检查 diff、PR 或某次提交。

text
请审查当前未提交变更。优先找链接错误、导航遗漏、构建风险和内容事实错误。

4. 修复型

用于根据报错闭环。

text
npm run docs:build 失败,错误如下:
<粘贴错误>

请定位根因,做最小修复,并重新运行构建。

让 Codex 更容易验证

提示里尽量直接给验证命令:

bash
npm run docs:build

如果是 UI 或交互变更,补充:

  • 需要打开哪个页面
  • 桌面和移动端分别看什么
  • 截图或 Playwright 检查标准

如果是内容整理,补充:

  • 来源范围
  • 是否允许外部搜索
  • 是否需要引用链接
  • 是否保留原文或只做总结

何时要求先计划

建议先计划的任务:

  • 多文件或多模块变更
  • 文档导航、构建配置、路由规则变更
  • 权限、网络、认证、安全相关变更
  • 依赖升级或构建工具调整
  • 需求不清晰,只知道大方向

可直接执行的任务:

  • 新增单篇文档
  • 修正错别字或链接
  • 按已知模板补内容
  • 运行检查并汇报结果

来源