~/VibeHandbook
免费 PDF

07 · 02

把项目结构组织得让 AI 能导航

AI 模型靠读你的代码来推理。一个混乱、铺得很开、不一致的项目,对它们来说和对你来说一样难。你不需要完美的架构,但有几个习惯能立刻见效:

  • **保持可预测的布局。**源码放一个地方,测试挨着源码或镜像源码的结构,配置放在根目录。
  • 使用清晰、描述性的命名。calculateMonthlyInvoiceTotal 胜过 calc2。AI 把名字当作线索。
  • **偏好更小的文件。**对你们俩来说,一个 200 行的文件都比一个 2000 行的更容易正确地修改。
  • **把相关的东西放在一起。**当一个功能的代码、样式和测试坐在一处时,AI 一次读取就能收集到上下文。
  • **保留一个清晰的入口点。**应用启动的那个明显的单一位置,给了 AI 一根在梳理项目时可以顺着拉的线。

一个典型的、对 AI 友好的布局可能长这样:

my-app/
├── AGENTS.md            # 给 AI 的项目规则 & 上下文
├── README.md            # 项目简介、如何运行
├── .env.example         # 记录所需密钥(无真实值)
├── .gitignore           # 排除 .env、构建产物、node_modules
├── package.json         # 脚本: dev, test, lint, build
├── src/
│   ├── features/
│   │   └── invoices/    # 单个功能的代码 + 测试,放一起
│   ├── lib/             # 共享辅助函数
│   └── index.ts         # 入口点
└── tests/               # 横切 / 集成测试

回报会复利式增长:你的项目越容易让 AI 导航,它的改动就越小、越精准。一个井井有条的仓库,让 AI 去碰三个相关文件,而不是在三十个文件之间瞎猜——这意味着更小的 diff、更少的事故,以及你真能读得下去的审查。如果你发现 AI 在做大刀阔斧、漫无焦点的编辑,真正的罪魁祸首往往是结构,而不是提示词。

想离线阅读?

免费下载整本书的 PDF 或 EPUB。