VVibeCoding 助手
🏗️05 阶段 · 项目工程化通用

项目结构规范:文件夹、命名、README 与给 AI 的规则

让项目和 AI 都「讲规矩」:文件夹怎么分、命名怎么起、说明书怎么写。

15 分钟 · ☑ 4 个实操任务

为什么结构重要

项目文件乱,AI 每次都要猜「这个文件是干嘛的」,改错地方的概率直线上升。结构规范了,人和 AI 都省心。

术语提示:文件 = 电脑里的一个文档,比如「index.html」;文件夹 = 装文件的「抽屉」,可以一层套一层;结构 = 文件和文件夹是怎么摆放组织的。

常见坏结构长什么样

my-project/
├── 新建文件夹 (2)/
│   └── 最终版-真的不改了.html
├── 测试.html
└── 12345.html

问题一眼可见:名字看不懂、乱放、分不清哪个是最终版。AI 在这种项目里干活,全靠猜。

文件夹怎么分(通用套路)

my-project/
├── src/         # 主要代码
│   ├── pages/   # 页面
│   ├── styles/  # 样式
│   └── utils/   # 工具函数
├── tests/       # 测试
├── README.md    # 项目说明书
└── package.json # 项目配置

不同项目不完全一样,原则就一条:一看文件夹名字,就知道里面放什么。

让 AI 帮你整理:

分析一下我的项目结构,告诉我哪里不规范,然后按「一看就懂」的原则帮我重构,重构完解释每个文件夹是干嘛的。

命名对照表

好名字坏名字
add-contact-form.js新建文件 (3).js
home.htmlaaaa.html
styles/main.css样式2.css
README.md说明文档-最终版-v2-真的不改了.md

规则就两条:全小写英文 + 短横线;不要用中文名、不要用「新建文件夹 (2)」。

.gitignore:告诉 Git 哪些不用管

项目根目录常有一个 .gitignore 文件,它是一张「忽略清单」:里面列的文件(比如临时文件、密码配置)不会被 Git 存档、也不会被推到网上。

术语提示:.gitignore 是一个以点开头的配置文件;开头有点,代表它是「隐藏配置」,平时不用管它。

让 AI 帮你配:

给我的项目写一个 .gitignore,把临时文件、缓存和不该公开的文件都忽略掉。

README:项目说明书

README 是给「未来的你」和 AI 看的说明书,包含:

项目名:
这个项目是做什么的:
怎么运行:
怎么测试:
主要文件说明:

直接让 AI 写:

根据我的项目,写一份 README,用大白话说明:项目是什么、怎么运行、怎么测试、文件结构。

给 AI 的规则文件(AGENTS.md)

在项目根目录放一个 AGENTS.md,里面写「AI 每次干活都要遵守的规矩」,比如:

项目规则:
- 文件命名用小写英文加短横线
- 改代码前先说明计划
- 改完必须跑测试
- 不要删除我没有要求的文件

以后 AI 在这个项目里干活,会自动读到这些规则。

下一步

结构规范了,接下来把这些检查动作自动化:下一课学一键检查和 CI。