技巧

rauchg 提出'双轨写作':README 手写,文档给 AI 读

Working on a new little project. The 𝚁𝙴𝙰𝙳𝙼𝙴 is fully written by hand, because it's for human c...

精选理由

Vercel 的 rauchg 分享了个挺实用的写作原则:README 写给人看就手写,内部文档给 agent 读就用 AI 风格,写文档时可以参考。

Vercel CEO Guillermo Rauch 分享了他正在开发的新项目里的一条写作原则:README 完全手写,面向人类读者;文档内部则用'AI English',面向 agent 读取。他举例说明适用范围:博客、推文、README 都属于人类沟通,不涉及风格细节(比如 em dash 的使用),而是与读者建立联系的表达环节。这条经验被定位成可复用的写作准则。

原文 · Guillermo Rauch

Working on a new little project. The 𝚁𝙴𝙰𝙳𝙼𝙴 is fully written by hand, because it's for human c...

Working on a new little project. The 𝚁𝙴𝙰𝙳𝙼𝙴 is fully written by hand, because it's for human consumption. The documentation internals are AI English, because they're for agents. This little rule of thumb can make the world better. Blogs, tweets, READMEs: human communication. It's not even about "em dashes" or lack thereof. It's that it's the story-telling moment where you want to connect with other humans through their words. 💬 43 🔄 12 ❤️ 273 👀 14082 📊 69 ⚡