GitHub 위키는 안티패턴이다 (2022)

GitHub 위키는 반패턴으로, 문서는 코드와 함께 관리해야 한다.

GitHub 프로젝트의 문서 관리는 위키보다 <code>/docs</code> 폴더에 함께 관리하고 GitHub Pages로 게시하는 것이 유리하다는 주장을 담고 있다. 문서를 코드와 함께 버전 관리하면 이전 버전의 문서를 쉽게 찾고, 저장소를 복제할 때 문서도 함께 다운로드해 활용할 수 있다.

GitHub wikis are considered an anti-pattern; documentation should be managed with the code.

The article argues that project documentation on GitHub should be managed together with the code in a <code>/docs</code> folder and published using GitHub Pages, rather than using wikis. This method allows for easier version control of documentation and ensures that documentation is downloaded alongside the repository when cloned.