给 coding agents 的“使用说明书”(译)

AI 时代程序员必备技能

Codex、Claude Code、Cursor、Hermes Agent、OpenClaw等工程化实战专栏 ,讲透 AI 如何接管脏活累活

原文标题:Onboarding for coding agents
原文链接:https://www.fuzzycomputer.com/posts/onboarding

最近我一直在折腾各种 AI 编程小助手:Claude Code、Cursor、Codex、Jules …… 真香归真香,但它们都一个臭脾气—— 你给多少上下文,它们就做多大事,而且每个家伙要的格式还不一样。

Cursor 要 .cursor/rules,Claude Code 找 CLAUDE.md,Codex 和 Jules 又想读 AGENTS.md,还有 .windsurfrules.clinerules.github/copilot-instructions.md…… 头都大了。

以前我把几百行提示全塞进 CLAUDE.md,最近我换了个懒人打法:

  1. 1. 所有上下文直接写 README(谁都看得懂)。

  2. 2. 规矩别写嘴里,全扔给 工具(类型检查、linter、formatter、测试)。

结果我的 CLAUDE.md 从几百行缩到 13 行,爽翻。

README 就是宇宙通用说明书

README 这玩意儿都活了 50 年,早就成了开发者默认“入口”。
于是我把各种提示从工具专属文件搬到 README,但又不想搞成一篇大作文,就整了个简单命名套路,按领域拆文件:

  • • README.md —— 项目或模块的大图。

  • • README.<领域>.md —— 某个具体方向的说明书。

比如:

  • • README.architecture.md

    • • 项目怎么搭的

    • • 关键架构决定

    • • 数据怎么在客户端和服务端跑

    • • 加新功能该按啥套路来

  • • README.commands.md —— 常用命令/脚本

  • • README.design.md —— 设计系统、组件、视觉规范

  • • README.testing.md —— 测试套路大全

📚 新员工入职包

这么拆完,上下文既模块化又不重复。
问题是:到底写哪些 README?

我的土办法就是把它当成给新人写的入职包——不管来的是真人同事还是 AI 小助手,都当他们啥都不懂。
你就想:明天组里来了一位新工程师/设计师,你得让他先读啥再动手?
把那堆东西统统写 README 里。

每一次新的 Cursor 或 Claude Code 会话,都相当于一个零背景的新同事空降。
你不先让他补课,他怎么干得漂亮?

于是我现在的 CLAUDE.md 只剩两行 onboarding 指令:

# CLAUDE.md

给 Claude Code 的小抄:

## 📚 入职第一步  
开干前先把下面全看一遍:
1. 所有 `**/README.md`  
2. 所有 `**/README.*.md`

** 会把子目录里的 README 也一起捞进来。
上下文都在 README 里,以后换啥工具都能直接复用。

✅ 质量闸门

入职包给了 AI 背景,那怎么保证它不写烂代码?

以前我把各种“规矩”贴在 .cursorrules 或 CLAUDE.md,现在懒得写,直接把规矩写进环境——
让工具当坏人,AI 当苦力,跑不过就别想交卷。

我叫它“质量闸门”:就是你能放心让新人 push 到生产前的那套检查。

最近一个 NextJS/TS 项目的例子:

## ✅ 质量闸门

Claude 写完代码必须跑完下面全部,一个不过就修,修完再跑,循环到全绿:

1. `pnpm type-check`  
2. `pnpm format`  
3. `pnpm lint`  
4. 单测全过 (`pnpm test:run`)

大模型对空格、import 排序、Tailwind 类顺序这些细节很容易翻车,
但它们擅长跑命令看报错再修,循环几次就全绿了。

具体用啥工具看你技术栈:TS 用 ESLint/Prettier,Python 用 ruff/pytest,Go 用 go fmt/vet/test……
总之把规矩往死里严就对了。

有了这两节(📚 入职包 + ✅ 质量闸门),我的 CLAUDE.md 现在真就 13 行。

软件也学会了 OODA 循环

为啥这套“质量闸门”最近突然这么好用?

一年前还不行,现在新模型(比如 Sonnet 4)+ 新工具(Claude Code)让小助手能一口气迭代好几分钟甚至几小时,直到所有约束全绿。

拔高视角:代码小助手现在能跑自己的 OODA 循环(观察-判断-决策-行动)。
以前只能按指令敲 token,现在能看结果、改代码、再跑检查,跟人类小菜鸟用 IDE 报错修 bug 一个路数。

人类几千年都是自己跑 OODA,现在工具也长了个初级版 OODA。

我心情复杂——
乐观面:老子当 builder 的杠杆感爆棚,复杂任务说甩就甩。
焦虑面:万一哪天工具把我们踢出循环,自己跑去追目标怎么办?

现在这 AI OODA 在软件工程最灵光,但别的领域只要能验证输出,估计也能套“质量闸门”。

你先定好“物理定律”

“氛围编程”(vibe coding)——你只喊需求,AI 全包办——确实爽又快。
但没规矩的话,分分钟给你整成屎山。

所以我给自己立了条铁律:绝不把“环境”交给 AI 氛围定。

我先定好“物理定律”:技术栈、组件、库、数据库、部署、设计系统……
这些改起来贵得离谱,还决定了项目的大部分约束。
定完后,让 AI 在笼子里随便飞。

真要加新库?我会让 Claude 给选项和利弊,但决定权在我,必须自己翻完文档再拍板。
一个烂依赖能毁项目,好抽象才让人爽到飞起。

严丝合缝的“物理定律”让我对 AI 产出更有底,Code Review 也轻松。
速度其实更快,因为我再也不用去 review 一堆半成品,等闸门全绿一次过。

推荐阅读

AI 时代程序员必备技能

Codex、Claude Code、Cursor、Hermes Agent、OpenClaw等工程化实战专栏 ,讲透 AI 如何接管脏活累活

内容概要:本文出自罗兰贝格关于工业4.0现状的报告,系统分析了制造业在数字化转型过程中的实际进展与挑战。报告指出,尽管“工业4.0”概念提出已逾十年,但多数企业仍未实现预期的智能化、自组织生产目标,主要受限于技术复杂性、组织孤岛、投资回报周期长及人才短缺等问题。通过对领先制造企业的研究,报告提炼出三大成功要素:一是制定基于现实的工业4.0愿景与全面战略,明确用例优先级;二是建立“中心辐射式”组织架构,设立专职数字化制造部门,推动跨职能协作与规模化落地;三是构建统一的IT/OT目标架构,强化数据生态与系统互操作性。报告特别强调,高价值用例如预测性维护、实时参数优化、视觉检测等已在汽车与半导体行业显现显著成效,企业应聚焦可量化回报的场景,结合资源现实,分阶段推进转型。; 适合人群:制造业企业管理者、数字化转型负责人、工业互联网从业者及政策制定者; 使用场景及目标:①帮助企业评估自身工业4.0成熟度并制定务实发展战略;②为制造企业设计组织架构与IT/OT技术路线图提供参考;③指导资源优先配置于高价值数字化用例,提升投资回报率; 阅读建议:建议结合企业实际生产场景阅读,重点关注“中心辐射式”运营模式与六大高价值用例的适用性分析,同时参考报告中的汽车行业案例,因地制宜地规划数字化路径。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值