ESC
开源 1 分钟阅读

GitHub Wiki 是一种反模式

一篇开发者观点文章指出,在 GitHub 项目中应避免使用 wiki:作者认为 wiki 虽然胜在“一直都在”,但弊端众多,堪称反模式,并主张将文档随代码存放在 docs 文件夹中,同时探讨了如何让文档便于查看。

来源:Hacker News

本文的初稿开头写道:“对于你的 GitHub 项目,你可以使用 wiki 或 docs 文件夹,两者都是合理的选择”。但随着写作的深入,我意识到使用 wiki 只有一个理由,而不使用 wiki 的理由却有很多。理由多到让我认为在 GitHub 上使用 wiki 是一种反模式。

让我们先来看看使用 wiki 的好处:

说真的,我能找到的使用 wiki 的唯一好处就是它一直都在那里。

那么不使用 wiki 的理由呢?

既然你已经接受了将文档与代码放在一起的想法,那么如何让人们方便地查看这些文档呢?