制定项目规范

🍕 项目需要规范,AI 也是

在上一期我们已经可以让 Codex 和 github 连接起来了,可以提交、推送、回滚代码。但是,每一次我们都要自己提交和推送,实在是不方便,有没有什么办法可以让整个项目来遵守自动提交呢?或者说,有没有一种方式可以构建一个项目规范呢?

答案是肯定的,这就是 AGENTS.md 和 Design.md 文档。

1 AGENTS.md

这是一个项目的规范文档,每一次 AI 生成内容的时候都会读一遍这个文档,因此,是绝对会执行的。

image

他一般是用来规范或者教会 AI 一些必要的特定操作或者问题的解决方式。例如:

  • 每次AI 生成后,要求自动提交代码;

  • 当遇到 xxxbug 的时候,必须使用 xxx 方案来解决,代码和架构如下…

不难看出,这是交给 AI 了一个特定项目的规范文档,有了这个东西,AI 就可以按照我们的要求来写代码,在这里,你可以写清楚这个项目是干嘛的,以及用的什么技术栈等等,当然可以实现我们刚才说的每一次代码变更都自动提交 Commit。

2 DESIGN.md

design.md 的名字其实就已经告诉我们它是做什么的了。

它就是用来规范设计的一些规范的(注意我这里没有说这是能直接让 AI 生成优质的设计稿,只是规范),例如品牌色、圆角等等,一般就是一些变量、字体样式、阴影以及其基础用法这些。

image

这个东西的作用在前段时间的营销中被严重高估了,其主要作用就是用来规范以下几件事情:

  • 规范全局变量和样式以及其使用规范;

  • 规范组件和控件的基础交互;

  • 规范交互流程、交互逻辑。

3 创建 AGENTS.md和 DESIGN.md

这个创建就是很简单了,你只需要在项目的根目录里面创建一个markdown 文件,命名为 AGENTS 或 design即可。当然,你依然可以使用 AI 帮你创建,这种创建方式一般 AI 会自动帮你梳理下载项目的一些基础规范。

提示词

创建一个 AGENTS.md 和 design.md

通常来说,这两个文档都会在项目开始就会创建。

4 使用建议

  • 在项目开始,也就是 Git 仓库初始化之后,就创建这2 个文档;

  • 如果遇到一个 AI 总是改错的问题,在修复好后,要求 AI 把这部分收敛到 Agents.md;

  • design.md 是可以从 Figma 的组件库直接利用 MCP 输出出来的,如果你有设计稿,那么可以这么做。

5 下一步

现在,我们的项目终于有规范了,然后我们知道如何利用计划模式让 AI 更好的干活,项目管理有 Git 工具了,但是,如果我们遇到了选择题——这个按钮蓝色的还是紫色的好,该怎么办呢?