AI 工具指南
Codex/Deep guide

Codex Readme Review

给新手的一套 README 人工审核流程：用 Codex 辅助发现缺口，但由人工确认项目用途、安装步骤、运行命令、环境变量、风险边界和交付记录。

What is the problem?

给新手的一套 README 人工审核流程：用 Codex 辅助发现缺口，但由人工确认项目用途、安装步骤、运行命令、环境变量、风险边界和交付记录。

Quick solution

Treat this as a Codex tutorial issue. First confirm the environment, inputs, permissions, logs, and delivery boundary. Then use the linked deep guide for the full checklist before changing production code or promising a result.

Read the deep guide

Detailed steps

  1. 先读项目入口。查看目录结构、package.json、README 原文、配置文件和主要页面。目标是知道项目大概做什么，而不是急着改文案。
  2. 让 Codex 做第一轮缺口扫描。可以要求它只列出 README 缺少的部分，例如项目简介、安装步骤、运行命令、环境变量、测试命令、部署说明、常见问题和许可证信息。
  3. 人工核对每一条建议。Codex 说需要 `npm run dev`，你要看 package.json 里是否真的存在；它说需要 `.env.local`，你要确认代码里是否读取这些变量；它说支持某个功能，你要在项目里找到证据。
  4. 运行最小验证。至少跑一次安装或已有依赖检查，再跑开发命令、测试命令或构建命令中的关键项。若报错看不懂，可以先用 [报错解释器](/tools/error-explainer)拆日志，不要直接把失败命令写进 README。
  5. 重写 README 结构。建议按“项目简介、适用场景、快速开始、环境变量、常用命令、目录结构、部署说明、常见问题、风险和限制”组织。小项目不必每项都很长，但缺失项要说明原因。
  6. 写交付记录。记录你改了哪些部分、验证了哪些命令、哪些内容仍需客户确认。若准备报价，可以先用 [报价计算器](/tools/pricing-calculator)估算审核和验证时间。

Commands or code

请只审核 README 是否完整，不要直接重写。
请按项目用途、安装步骤、运行命令、环境变量、测试/构建、部署、风险说明列出缺口。
每一条建议都要说明需要从哪个文件或命令验证。

Risk notes

Confirm the real project environment, account permissions, platform rules, and output quality before delivery. Do not ship AI-generated changes without human review, and do not claim indexing, income, deployment success, or ranking improvements without measured evidence.