新项目一上来就写 CLAUDE.md,最容易写成两种废话:要么把项目简介抄一遍,要么列一堆放之四海而皆准的“规范”。两种都对 AI 没用——AI 需要的是这个项目特有的约定:目录长什么样、命令怎么跑、什么算错。三套模板只解决这一件事:按项目类型先选对骨架,再把 `` 占位换成你自己的信息。

用法(三套通用):把对应文件复制为仓库根目录的 CLAUDE.md,按注释改掉 ` 标记的项目特有信息;配合工作流包的 10 个中文 slash commands 使用(/plan /test /review /commit /doc` 等)。不要三套全抄——只选一套,删掉不适用的段落,留下的每一条都得是你项目真实的约定。

三套怎么选(按仓库长相,不按喜好):

  1. 文档站选 docs-site:仓库主体是 Markdown,配 VitePress 之类框架。模板约定的目录:docs/ 放 Markdown 源文件,docs/.vitepress/(或对应)放框架配置,图片统一放 docs/public/images/;文件名用英文小写短横线(如 getting-started.md),标题用中文。硬性规范两条:每篇文档开头一句话说清“这篇解决什么问题、适合谁看”,超过 800 字的加目录;操作步骤必须是“照着做能走通”的——命令可复制、路径真实存在、截图与当前版本一致,写完自己照着走一遍(可用 /doc 检查)。常见错:把“照着做能走通”写成口号,步骤里的命令自己没跑过。
  2. Python 脚本/小工具选 python-scripts:仓库主体是 .py,带测试或定时任务。模板约定的目录:src/ 或项目根放主逻辑,tests/ 放测试(test_*.py),scripts/ 放一次性运维脚本;有定时任务的,把 cron 配置写进 docs/,不要只记在脑子里。常用命令写死四条:建虚拟环境(只做一次)、pip install -r requirements.txt、 pytest 跑全部测试、python -m src.main 本地跑一次主流程。常见错:定时任务只存在于某台机器的 crontab 里,换机器就丢。
  3. Web 全栈选 web-fullstack:仓库同时有前后端。模板约定的目录:frontend/ 前端代码,backend/ 后端代码,docs/ 项目文档;不要把构建产物(dist/、build/)提交到 git。硬性规范:API 返回统一信封 { "code": 0, "data": ..., "message": "..." },code != 0 即失败,不要裸抛堆栈给前端。常见错:信封只在新接口用,老接口各写各的,前端永远不知道这次返回算成功还是失败。

选完之后的三条使用规则:

  1. 占位符必须清零再提交。没改掉就等于没写——AI 会把占位符当成真实信息用,或者直接忽略整段。提交前 grep 一遍,有残留就先改完。
  2. 模板是起点,不是封顶:项目特有的约定往上加,模板里没有的硬规则(比如“数据库迁移只用 alembic”)自己补;模板里不适用的段落删掉,别留着“以防万一”——留下的每一条 AI 都会当真。
  3. CLAUDE.md 写完要跑一遍验证:让 AI 按文件里的命令从头走一次(装依赖、跑测试、起服务),走不通的地方就是文件里写错的地方。模板本身不保证正确,只保证结构不缺项。

什么时候不要用模板:项目还没定型、技术栈一周换两次——这时写 CLAUDE.md 是给自己加维护负担,先让目录和命令稳定下来;想把三套拼成一套“全能模板”——三套的目录约定互相冲突,拼出来的文件 AI 没法执行;只想抄个样子应付检查——占位符没清零的 CLAUDE.md 还不如没有。

免费先试:Lite 免费版含 /review、/commit、/test 三条命令,双兼容 Claude Code 与 Codex CLI,见 Lite 仓。
完整版含 10 条命令与三套 CLAUDE.md 模板,早鸟 ¥9.90(限前 100 份)/正式 ¥19.90,付款后 12 小时内私信交付,7 天无理由退款。国内账号风控提示:优先用 Codex。

链接: