README, 非
摘要
一篇博客文章建议在项目中添加一个 READMENOT 文件,以明确表明代码是 AI 生成的垃圾内容,不供人类直接阅读,帮助用户避免浪费精力在机器输出上。
<p><a href="https://lobste.rs/s/wveduf/readme_not">评论</a></p>
查看缓存全文
缓存时间: 2026/07/16 13:56
# 请勿阅读说明
来源:https://blog.yossarian.net/2026/07/16/README-not
## ENOSUCHBLOG
## *编程、哲学、骑行。*
- 主页(https://blog.yossarian.net/)
- 标签(https://blog.yossarian.net/tags)
- 系列(https://blog.yossarian.net/series)
- 收藏(https://blog.yossarian.net/favorites)
- 归档(https://blog.yossarian.net/archive)
- 主站(https://yossarian.net/)
- 今日学(https://yossarian.net/til/)
---
## *2026年7月16日*标签:ai(https://blog.yossarian.net/tags#ai),oss(https://blog.yossarian.net/tags#oss)
---
Borat 说“不”
(感谢 Facundo Tuesca(https://github.com/facutuesca)提供名称灵感。)
如果你和我一样,你会花大量工作时间(以及不少个人时间)在线阅读代码。而这意味着,越来越多地,你会不小心读到大量“垃圾内容”¹(https://blog.yossarian.net/2026/07/16/README-not#fn:slop)。
就我个人而言,垃圾内容本身并不令人厌烦²(https://blog.yossarian.net/2026/07/16/README-not#fn:codegen):例如,个人软件³(https://blog.yossarian.net/2026/07/16/README-not#fn:personal)可以是垃圾内容,这没问题。令人厌烦的是那种上当受骗的感觉:就像文字作品一样,我希望在将宝贵的人类注意力投入机器输出之前,能事先*得知实情*⁴(https://blog.yossarian.net/2026/07/16/README-not#fn:informed)。
我深信应该给予人们表达真实意图的途径。比如,我*确实*有时想往互联网上扔些垃圾内容(供自己日后保存,或供他人复用而不必细读),但我不希望误导他人对其意图或付出程度的认知。
那么:我们能否给人们一种方式,让他们诚实地表达自己对垃圾内容的意图?我们使用 `README` 文件来告诉用户从何开始阅读一个项目;我认为我们也应该有一个 `READMENOT`⁵(https://blog.yossarian.net/2026/07/16/README-not#fn:naming)文件,供用户(或其代理)在制造垃圾内容时添加到项目中。该文件的存在将作为一项明确警告:项目中的代码不适合*无意中*被人类理解⁶(https://blog.yossarian.net/2026/07/16/README-not#fn:comprehension)。
`READMENOT` 可以包含任何内容,但在我看来,一个好的默认设置是对*为什么*不应阅读该项目给出简短、人工可读的解释。例如:
```
1
2
3
4
5
警告!
您正在阅读一个不打算供直接人工消费的项目。
建议您使用 LLM 或其他工具与此项目进行自动交互。
```
---
---
相似文章
代码审查需要认真阅读代码
一篇开发者博客文章反对在不阅读 AI 生成代码的情况下直接将其部署到生产环境,强调代码审查具有至关重要的作用:分散责任、降低巴士因子风险,以及让团队成员保持对代码库的了解。
@DanKornas:编写有效的 README 不应该比项目本身花费的时间更长。ReadmeAI 是一个 Python CLI 工具,专为那些想要……的开发者设计。
ReadmeAI 是一个 Python CLI 工具,能从本地或远程仓库自动生成结构化的 README 文件,支持多种 AI 模型或离线模式,并提供定制选项。
AI 让我意识到,我不再喜欢阅读长篇 Markdown 文档了
作者反思了 AI 生成文档如何让偏好从 Markdown 转向 HTML,以获得更好的可读性和视觉组织——因为 AI 生成的内容越来越复杂。
引用肯顿·瓦尔达
肯顿·瓦尔达宣布其团队暂停使用AI编写的变更描述(包括PR/提交信息、问题/工单),理由是该AI省略了代码审查所需的高层框架,生成的描述比无用更糟糕。
@garrytan: 我刚刚为GBrain做的元提示示例,用于重写最新PR中的README:以从未使用过GBrain且对其一无所知的用户身份阅读README…
Garry Tan展示了一种元提示技术,用于为GBrain重写README,通过从新手用户的角度评估并迭代改进,最终达到完美评分。