项目说明文件：让编码助手记住你的约定
编码助手每次新开对话都会"失忆"。把项目架构、关键约定、测试命令和踩过的坑写进项目说明文件，它每次都能按你的规矩干活。
用 AI 编程工具做项目，经常遇到这种情况：上次已经说过"时间统一用毫秒""改完要跑测试"，新开一个对话它又忘了，同样的错误再犯一遍。
解决办法是写一份项目说明文件，放在项目根目录。大多数 AI 编程工具都支持在开工时自动读取这类文件（具体文件名和用法以你所用工具的说明为准）。
一、写哪些内容
| 部分 | 内容 |
|---|---|
| 项目简介 | 这个项目是做什么的，一两句话 |
| 技术栈 | 用了什么框架、数据库、部署平台 |
| 目录结构 | 主要目录分别放什么 |
| 关键约定 | 命名规则、时间格式、版本号放在哪里等 |
| 常用命令 | 怎么启动、怎么测试、怎么部署 |
| 已知的坑 | 之前出过的问题和正确做法 |
| 禁止事项 | 不要改哪些文件、不要把密钥写进代码 |
以下为会员内容
本文为 AI 编程 会员内容。开通会员后可阅读全部教程、问答和模板：12 月 3 日前限时 ¥199/年（原价 ¥365），开通送 voicemake.cn 高级会员 1 个月，会员可 1V1 咨询。