-
Vercel-update-docs：把”文档同步”从口头约定变成工程流程
代码和文档不同步，大概是开源项目里最普遍的慢性病。API 改了签名，文档还停在三个月前；组件加了新 prop，示例代码还是旧的。小项目可以靠维护者记性好，但 Next.js 这种几千个文件的仓库，靠记性早就崩了。 Vercel 的做法是把这个流程塞进 Agent 里。next.js 仓库的 .agents/skills 目录下维护着一个官方 skill，叫 update-docs。维护者审查 PR…- 1k
- 0
-
OpenAI 把工程师的经验写进了仓库：docs-sync 是怎么让文档和代码不再脱节的
你有没有遇到过这种情况：翻遍官方文档，照着配置写好了代码，跑起来就是报错。排查了半小时才发现，文档里写的参数名早就不用了，代码里已经换成了新的。你气的不是代码写错了，是文档骗了你。 这件事不只你遇到过。OpenAI 的 Agents SDK 团队也在头疼。两个仓库、几千个 API 接口、每周几十个 PR，文档跟不上代码的节奏是常态。修 bug 时顺手改了个参数名，谁会记得去同步文档？这种“文档漂移…- 1.2k
- 0