AI 工具指南

Codex Readme Review Checklist

一份适合新手的 README 审核清单,用 Codex 辅助检查项目说明、安装命令、环境变量、测试构建、部署信息、风险边界和交付记录。

What is the problem?

一份适合新手的 README 审核清单,用 Codex 辅助检查项目说明、安装命令、环境变量、测试构建、部署信息、风险边界和交付记录。

Quick solution

Treat this as a Codex checklist 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. README 是否用一两段话说明项目用途。
  2. 是否说明目标用户或适用场景。
  3. 是否说明当前状态,例如练习项目、内部工具、演示版或待完善版本。
  4. 是否有截图或示例链接;如果有,是否经过授权。
  5. 是否避免夸大功能。
  6. 是否说明依赖条件,例如 Node、包管理器、数据库或外部服务。

Commands or code

The source article does not include a copyable command block. Do not invent commands here; follow the diagnostic steps in the deep guide and validate changes in the real project environment.

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.