🤖 现代 AI 开发者 · 上下文工程:喂 AI 刚刚好的信息

给 AI 写说明书:项目规约 / Design Doc 入门(如 CLAUDE.md)

Design Doc / 项目规约入门

说明书:把规矩写一次,省得每次重复

每次都得叮嘱 AI “用中文、别用某某库、提交前先跑测试”,烦不烦?把这些固定规矩写成一份说明书,让它每次自动读,你就解放了。

🔆像给新来的同事一份入职手册:公司规矩、代码风格、踩过的坑,白纸黑字写清。他不用每件事都来问你,照着手册办就行。

在很多 AI 编程工具里,这份说明书就是项目里的一个文件(比如 CLAUDE.md),AI 每次干活前会先读它。

什么该写进去:稳定、反复用的约定

判断标准很简单:这条规矩是不是稳定、会反复用到?是,就写进说明书;只是这一次的临时要求,放普通提问里就好。

# 项目说明(给 AI 读)
- 一律用中文回复
- 数据库改动必须写迁移脚本,禁止手改表
- 提交前先跑 `npm test`,全绿才提交
- 命名用小写连字符:user-profile,不要 userProfile
💡好测试:如果一件事你已经叮嘱过第二遍,它八成就该进说明书了。

写好说明书:具体、可执行、别太长

说明书也是上下文的一部分——每次都会占桌面。所以原则和好上下文一样:具体、可执行、保持精简

⚠️别把它写成长篇大论。塞了一堆“最好、尽量、原则上”的空话,既占地方又没人照做。每条都要能直接照着执行。

一句话:说明书是给 AI 的规矩清单,短、准、能照做,比长而虚强得多。

自测 · 学完检查一下

想真正动手做题、记进度、攒连胜?到互动课里练。

“给 AI 的说明书 / 项目规约”主要解决什么问题?

答案:把固定规矩写一次,免得每次重复叮嘱

说明书像入职手册:把反复要交代的规矩写下来,AI 每次自动读,省得你一遍遍重复。

判断:在一些 AI 编程工具里,这份说明书就是项目里的一个文件(如 CLAUDE.md),AI 干活前会先读它。

答案:

确实如此:把项目约定写进一个固定文件,AI 每次开工先读,相当于把规矩自动摆上桌面。

下面哪条最适合写进项目说明书(而不是放在普通提问里)?

答案:“本项目一律用中文回复、提交前必须跑测试”

稳定、会反复用到的约定才进说明书;其余三条都是只针对当下的一次性要求,放普通提问即可。

一个简单的判断法:如果同一件事你已经叮嘱过 ___ 遍,它八成就该写进说明书了。

答案:第二

反复出现的要求就是稳定约定,写进说明书一劳永逸;一次性的临时要求则不必。

判断:说明书写得越长越详尽越好,把所有“最好、尽量、原则上”都堆进去最保险。

答案:

说明书每次都占上下文,过长又空泛反而干扰。原则是具体、可执行、保持精简,每条都能直接照做。

下面哪条说明书写法最好?

答案:“提交前先跑 `npm test`,全部通过才提交”

好规矩要具体可执行:有明确动作和判断标准。其余几条都是没法照做的空话。

想边练边学,而不只是读?

到互动课里答题、记进度、攒连胜——游客即可试学,无需注册。

进入互动课程 →