过几天再打开项目,就不知道怎么启动了,怎么办?
让 AI 在项目里写一份启动说明,包括装依赖、配置环境变量、初始化数据库、启动前后端的完整命令和顺序,以及常见报错的处理方法。每次环境有变化就同步更新。以后无论是自己隔一段时间回来,还是换一个新对话,都可以照着说明一步一步拉起项目。
让 AI 写一份启动说明,放在项目根目录。
很多人第一次跑通项目,是在 AI 的一步步指挥下完成的。过几天再打开,命令全忘了,前后端谁先启动、数据库怎么初始化都想不起来,只能重新问一遍。
启动说明写什么
- 需要提前安装的软件和版本;
- 安装依赖的命令;
- 需要配置的环境变量,只写变量名和用途,不写真实值,真实密钥另外妥善保存,见「密钥、证书别贴进聊天:AI 协作开发的敏感信息管理」;
- 初始化数据库的步骤;
- 启动前端、后端的命令和顺序;
- 启动成功后应该看到什么,访问哪个地址;
- 常见报错和处理方法。
什么时候更新
- 新增了依赖或服务;
- 改了端口、改了配置方式;
- 遇到了新的启动报错并解决了。
可以在项目规则文件里加一句"环境有变化时同步更新启动说明",让 AI 自己维护,见「项目说明文件:让编码助手记住你的约定」。
额外的好处
换新对话时,让 AI 先读启动说明,它就能快速了解项目怎么运行,不用从头摸索。交付给客户时,这份说明也可以直接作为交付文档的一部分。