Github Wiki 활용해보기

Why Github Wiki?

코드스쿼드 부트캠프에 참여한 지 벌써 3달이 넘는 시간이 훌쩍 지났고, 4월 4일부터 본격적으로 팀 프로젝트에 도입했다. 이제 정말 팀으로서 하나의 결과물을 내야 하는 것이다. 페어 프로그래밍과는 또 다른, 제대로 된 협업을 경험해 보는 것이다. 협업을 하면서 Github의 기능 중 하나인 Wiki를 사용해 보라는 제안이 있었다. 막상 적어보려고 하니 막막해서 무엇을 적으면 도움이 될지에 대해서 정리해 보려고 한다. 

 

My Goal

개발 문서 작성법을 알고, 추후 프로젝트에 적용시키기

 

[Git] github 위키 기능 및 사용법

일단 무작정 github wiki라고 구글링을 해 봤고 위 글을 찾았다. 여기서는 개발 문서의 중요성과 Wiki를 작성하는 방법에 대해서 설명하고 있다.  

프로젝트를 할 때, 소스코드뿐만 아니라 개발 문서도 중요하다는 것. 

특히 프로젝트의 규모가 크고, 복잡도가 높고, 참여하는 인원이 많을수록 이 중요성은 커진다고 한다. 개발문서 하나만 잘 작성되어 있어도 커뮤니케이션 비용이 줄고, 버그 가능성도 낮아지기 때문이다. 

 

Projects with great wikis

https://www.quora.com/What-are-some-examples-of-very-well-made-GitHub-wiki-pages-for-open-source-projects

GitHub - Netflix/Hystrix: Hystrix is a latency and fault tolerance library designed to isolate points of access to remote system

 

잘 쓴 위키로 뽑힌, 위 사이트를 들어가 보면 이런 식으로 굉장히 꼼꼼하고 체계적으로 작성되어 있는 것을 알 수 있다.

Netflix에서 만든 Hystrix라는 라이브러리인데 소개부터 시작해서 환경설정, 자주 묻는 질문, 사용법, 플러그인 등등 이 라이브러리를 쓸 때 궁금할만한 점들을 모두 적어놓았다. 

 

---

 

지금 당장 완벽한 Wiki를 작성할 순 없을 것 같고 일단 어설프더라도 적어볼 만한 것들을 적어보고, 점점 개선해 나가봐야겠다.