用 Codex 写项目文档：给新同事看的 README 和上手指南

很多项目不是缺代码，而是缺一份“新人第一天能看懂”的文档。Codex 可以帮你从真实代码和配置里整理 README、启动说明和排错指南。

先让 Codex 读项目，不要直接写

请先阅读项目目录、README、package.json、docker-compose、Makefile 和 CI 配置。
不要修改文件。
请告诉我：
1. 项目怎么启动；
2. 主要模块是什么；
3. 测试和构建命令是什么；
4. 你不确定的信息有哪些。

让它先列“不确定信息”很重要。这样可以避免它编造启动命令。

可以要求：

请基于刚才读到的真实信息，生成一版 README 草稿。
面向第一次接手项目的新同事。
结构包括：
- 项目是什么；
- 本地环境要求；
- 启动步骤；
- 常用命令；
- 目录结构；
- 常见问题；
- 部署注意事项。

如果某个命令或配置无法从项目里确认，请标注“待确认”，不要猜。

这能显著提升文档可信度。

让 Codex 按文档自己走一遍：

请按你写的 README 启动步骤检查一遍。
如果有命令无法执行，说明原因并修改文档。

如果环境缺依赖，不一定要安装，但要在文档里写清楚。

不要让 Codex 直接写“企业级最佳实践”。项目文档应该来自当前项目，而不是通用模板。

不要把密钥、数据库密码、私钥路径暴露在公开 README 里。可以写变量名和配置位置，但不要写密钥内容。

不要用文档替代自动化检查。README 只是入口，真正的可靠性仍然来自测试和脚本。