Guillermo Rauch(@rauchg)
Working on a new little project. The 𝚁𝙴𝙰𝙳𝙼𝙴 is fully written by hand, because it's for human c...
7.0内容质量
TL;DR · AI 摘要
区分面向人类与AI的文档编写方式能提升沟通效率，README需人工撰写以增强可读性，内部文档可用AI生成英文。
核心要点
- README应完全人工撰写以确保人类可读性
- 面向AI的文档可使用AI生成英文内容
- 技术沟通应侧重故事叙述而非标点符号
结构提纲
按章节快速跳转。
思维导图
用一张图看清主题之间的关系。
查看大纲文本（无障碍 / 无 JS 友好）
- 技术文档双轨原则
- 人类面向文档
- 手写README
- 故事叙述
- AI面向文档
- AI生成英文
- 结构化数据
金句 / Highlights
值得收藏与分享的关键句。
README is fully written by hand, because it's for human consumption.
Documentation internals are AI English, because they're for agents.
It's not even about 'em dashes' or lack thereof.
#技术写作#AI应用#文档规范
打开原文Guillermo Rauch 在 X 上的推文： "正在开发一个新项目。README 是完全手写的，因为它是给人类阅读的。内部文档使用 AI 英文，因为它们是给智能体使用的。这个小经验法则可以让世界变得更好。博客、推文、README：这些都是人类沟通。这甚至与破折号是否存在无关。这是你通过文字与其他人建立联系的讲故事时刻。"
@rauchg
正在开发一个新项目。README 是完全手写的，因为它是给人类阅读的。内部文档使用 AI 英文，因为它们是给智能体使用的。这个小经验法则可以让世界变得更好。博客、推文、README：这些都是人类沟通。这甚至与破折号是否存在无关。这是你通过文字与其他人建立联系的讲故事时刻。
2026年10月4日 下午8:45
·
45.9K
次浏览
103
28
788
165