art-of-readme

# README 的艺术 > 来源: [hackergrrl/art-of-readme](https://github.com/hackergrrl/art-of-readme) *本文也可阅读 [中文](README-zh.md)、[日语](README-ja-JP.md)、[巴西葡萄牙语](README-pt-BR.md)、[西班牙语](README-es-ES.md)、[德语](README-de-DE.md)、[法语](README-fr.md) 和 [繁体中文](README-zh-TW.md) 版本。* ## 词源 “README”这个词从何而来？ 这种命名法至少可以追溯到 20 世纪 70 年代 [PDP-10](http://pdp-10.trailing-edge.com/decuslib10-04/01/43,50322/read.me.html)，尽管它甚至可能追溯到在打孔卡堆上放置信息性纸条的时代，上面潦草地写着“READ ME!”，描述其用途。 一位读者^{[1](#footnote-1)}建议，README 这个标题可能是对刘易斯·卡罗尔的《爱丽丝梦游仙境》的一种俏皮暗示，书中分别有一瓶药水和一块蛋糕，上面贴着“喝我 (DRINK ME)”和“吃我 (EAT ME)”的标签。 README 以全大写形式出现是历史上一贯的特征。除了全大写在视觉上的醒目之外，UNIX 系统会将大写字母排在小写字母之前，从而方便地将 README 排在目录其余内容之前^{[2](#footnote-2)}。 意图很明确：*“这是用户在继续操作之前需要阅读的重要信息。”* 让我们一起探讨在现代社会中，什么构成了“重要信息”。 ## 为创作者，为消费者 这是一篇关于 README 的文章。关于它们的作用、为什么它们是绝对必要的，以及如何精心地撰写它们。 这是为模块创建者编写的，因为作为模块的构建者，你的工作是创造持久的东西。这是一种内在的动力，即使作者无意分享其作品。一旦 6 个月过去，没有文档的模块就会显得陌生。 这也是为模块消费者编写的，因为每个模块作者同时也是模块消费者。Node 具有非常健康的相互依赖度：没有人生活在依赖树的最底层。 尽管专注于 Node，但作者认为其经验同样适用于其他编程生态系统。 ## 许多模块：有好有坏 Node 生态系统由其模块驱动。[npm](https://npmjs.org) 是使其运转的魔法。在一周的时间里，Node 开发人员会评估数十个模块以纳入其项目中。这是正在产生的大量力量...