GitHub Wikiより `/docs` を勧める理由
GitHubのプロジェクトで、ドキュメントを wiki に置くべきか、それともリポジトリ内の `/docs` フォルダに置くべきか。この記事は、その定番の悩みにかなりはっきりした答えを出しています。筆者は wiki の利点を認めつつも、実際には欠点のほうが多く、GitHub の wiki はアンチパターンだとまで言い切ります。単なる好みの話ではなく、利用者と保守者の両方にとってどちらが扱いやすいか、という視点で整理しているのがポイントです。 元記事は、GitHub プロジェクトで「wiki を使うべきか、`/docs` フォルダを使うべきか」という議論が半年おきくらいに出てくる、と前置きしたうえで、自分の考えを明文化したものです。筆者は当初、「wiki でも `/docs` でもどちらも正しい選択肢」と書き始めたそうですが、書き進めるうちに見方が変わり、wiki を使う理由はほぼ一つしかないのに、使わない理由はたくさんあると結論づけています。そのため、GitHub の wiki はアンチパターンだと位置づけました。 筆者が認める wiki の利点は、リポジトリのどこからでも一クリックで
papoo.work