GitHub 위키는 안티패턴이다
원제 The GitHub wiki is an anti-pattern (2022)
135 포인트댓글 76

Key Point
GitHub 저장소의 문서 관리 방식을 선택할 때, 위키보다 /docs 폴더가 버전 관리, 코드 리뷰, 로컬 접근성에서 월등히 우수한 이유를 알 수 있다.
핵심 요약
- GitHub 위키의 유일한 장점은 저장소에서 한 클릭으로 접근할 수 있다는 것이다.
- 반면 /docs 폴더를 사용하면 문서가 코드와 함께 버전 관리되고, 로컬 클론 시 자동으로 포함되며, 풀 리퀘스트를 통해 피어 리뷰를 받을 수 있다.
- 위키는 이미지 업로드를 지원하지 않고, 커스터마이징 옵션이 제한적이며, 문서 편집에 깃허브의 PR 프로세스를 적용할 수 없다.
- /docs 폴더에 문서를 두고 GitHub Pages를 통해 배포하면서, 위키에는 호스팅된 문서로 연결하는 페이지 하나만 남기는 것을 권장한다.
- 문서가 증가하면 나중에 별도 저장소로 분리할 수 있으며, 기여자들은 이미 저장소 기반 작업에 익숙해진다.