程序员JavaScript项目开源项目GitHub

有哪些 GitHub 项目的 README 堪称教科书?

地铁风
不会撸程序的设计狮不是好科研狗

其实写 README 和写其他文学/文档一样,无非就是那 5W + 1H(这个好像是新闻学里的说法?)。

  • 5W: What, When, Where, Who, Why
  • 1H: How

换一个不那么高大上的,人人都知道:时间地点人物,起因经过结果。这些都交代清楚了,自然就是个好文档,万变不离其宗。小学语文。

这个原则不仅适用于写作,还适用于其它一些领域,比如管理文档时如何贴 tag。

12 赞同 1 感谢 6 收藏 0 条已备份评论 发布于 2018-12-12 知乎原页 ↗

评论 0

没有已备份的评论。