跑不通的代码示例,一律不许上线!AI 写的文档全是坑?这个脚本让每段代码先跑一遍再上线
开发者提出一条硬规则:文字可以让模型写,但证明文字的代码示例必须真跑通,跑不通就变成某个具体人的锅。
大白话AI 写文档最大的问题不是句子难看,而是里面的示例早就过期了:参数改名、返回字段挪位、命令悄悄开始报警告,复制粘贴就崩。这位作者的做法很朴素——写个脚本把文档里所有代码块抠出来,能跑的真跑一遍,输出一份 JSON 报告。跑不过的示例不许上线,标成「需要指定负责人」。文字部分模型随便重写,代码示例只有人点头才算数。
对你意味着如果你用 AI 批量生成 README、教程或 API 文档,这套思路能直接抄;不然读者照着抄一遍就报错,锅还是你的。
原文:Run the Fence Before You Ship the Paragraph: An Executable-Example Gate for Model-Drafted Docs
打开巨象雷达,看今天全部 AI 动态