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 或其他工具与此项目进行自动交互。
```
---
---
相似文章
@rauchg: 拒绝不理解。低质量内容不仅仅是代码和PR。我们面临一个真实的风险,即*阅读*可能会完全被忽视…
这条推文警示AI生成低质量内容的风险,引用了一个例子:PR描述中错误地将性能提升归因于编译器变更,实则是由于算法改进。它主张AI应服务于增强理解与人类认知。
代码审查需要认真阅读代码
一篇开发者博客文章反对在不阅读 AI 生成代码的情况下直接将其部署到生产环境,强调代码审查具有至关重要的作用:分散责任、降低巴士因子风险,以及让团队成员保持对代码库的了解。
@DanKornas:编写有效的 README 不应该比项目本身花费的时间更长。ReadmeAI 是一个 Python CLI 工具,专为那些想要……的开发者设计。
ReadmeAI 是一个 Python CLI 工具,能从本地或远程仓库自动生成结构化的 README 文件,支持多种 AI 模型或离线模式,并提供定制选项。
@rauchg:正在做一个新的小项目。𝐑𝐄𝐀𝐃𝐌𝐄 是完全手写的,因为它面向的是人类读者。文档……
Guillermo Rauch (rauchg) 暗示了一个新的小项目,他主张 README 和博客应当由人来撰写,以进行人类叙事;而内部文档则可以用「AI English」(AI 英文)编写,供智能体(agent)消费。
@dzhng: https://x.com/dzhng/status/2090252351533973768
这篇文章讨论了因人工审查瓶颈而产生的AI生成代码‘垃圾’问题,并指出软件工程必须演进,以系统设计为重点,而不是代码的可读性。