补 README 是非常适合 Codex 的基础任务，尤其适合非开发用户。
> 前置教程：常见任务实战：让 Codex 新增一个简单页面
> 如果你还没有练习过新增文件和范围控制，先完成前置教程。
> 依据来源：OpenAI Codex 官方手册中的项目阅读、提示词、文档编写、验证和 diff 审查建议。
适合这些任务：
- 给项目补 README。
- 给新功能补使用说明。
- 给部署流程补说明。
- 给团队项目补“如何启动”。
不适合：
- 让 Codex 编造不存在的功能。
- 让 Codex 写没有验证过的安装步骤。
- 让 Codex 把密钥、账号、私有地址写进文档。
第 1 步：先让 Codex 读项目
文档不能凭空写。
先让 Codex 只读分析：
``
请只读分析当前项目，不要修改任何文件。
我准备补 README 或使用说明。请告诉我：
- 项目是什么类型。
- 项目简介。
- 不要编造不存在的脚本。
- 说明这个功能解决什么问题。
- 大纲是否适合目标读者。
- 是否出现编造内容。
- 是否遗漏启动步骤。
- 是否把不确定内容标出来。
- 列出 README 中提到的命令。
- 命令是否真实。
- 路径是否真实。
- 功能是否真实。
- 是否有敏感信息。
- 是否把“不确定”写成了确定。
- 一份不编造的 README。
- 真实命令和目录说明。
- 不确定内容已标记。
- 没有敏感信息。
- Codex 给出文档可靠性检查。
2. 有哪些安装、启动、构建、测试脚本。
3. 主要目录结构是什么。
4. README 里应该包含哪些内容。
5. 哪些内容你不确定，需要我确认。
`
这一步很重要。如果 Codex 不确定，就应该说不确定，而不是编。
第 2 步：发出文档编写任务
你可以让 Codex 写不同类型的文档。
场景 1：补项目 README
`
请帮我补一份 README。
目标读者：
第一次拿到这个项目的人。
要求包含：
2. 技术栈。
3. 本地环境要求。
4. 安装依赖。
5. 启动开发服务。
6. 构建项目。
7. 目录结构说明。
8. 常见问题。
限制：
2. 不要写真实 API Key。
3. 不要写我没有提供的线上地址。
4. 不确定的地方请用“待确认”标记。
`
场景 2：补功能说明
`
请帮我给【功能名称】补一份使用说明。
要求：
2. 说明入口在哪里。
3. 说明操作步骤。
5. 写常见问题。
6. 不要编造不存在的按钮或页面。
`
第 3 步：让 Codex 先给大纲
不要一上来让它写完整文档。
先问：
`
先不要修改文件。
请先给 README 大纲，并标出哪些内容来自项目文件，哪些内容需要我确认。
`
你要检查：
第 4 步：让 Codex 写文档
确认大纲后：
`
可以按这个大纲补 README。
请尽量基于项目中真实存在的脚本和目录来写。
不确定的内容用“待确认”标记。
不要写真实密钥。
`
第 5 步：自查文档可靠性
文档写完后，让 Codex 自查：
`
请检查 README 是否可靠。
要求：
2. 判断这些命令是否来自项目真实配置。
3. 标出所有你不确定的内容。
4. 检查是否误写了密钥、账号、私有地址。
``
你要重点看：
完成后，你应该得到：
下一篇看：常见任务实战：让 Codex 修改一段接口逻辑。