프로젝트에서 소스코드만큼 중요한 것이 개발문서입니다. 프로젝트에 참여하는 인원수가 많을수록 개발문서를 잘 작성함으로써 커뮤니케이션도 원활해지고, 버그 생성 가능성도 낮아지는 등 얻는 이점이 많을 것입니다.
이러한 개발 문서를 작성하는것은 여간 귀찮은 일이 아닌데요, 이러한 작성을 약간이라도 도와주는 것이 github의 Wiki 입니다.
Wiki
깃허브에서 자신의 레포지토리 페이지에 들어가게 되면 상단 메뉴바에 Wiki 라는 탭을 눌러 위키 기능을 사용할 수 있습니다.
만약 Wiki 탭이 보이지 않는다면 비활성화 되어있을 가능성이 높기 때문에 Settings 탭에 들어가서 Features 항목에 Wiki 체크박스를 활성화하면 저장소에서 위키를 사용할 수 있습니다.
사진 예시
Wiki 페이지 생성해보기
Wiki 탭으로 처음 들어가면 화면 중앙의 Create the first page 버튼을 통해 페이지를 생성 할 수 있습니다. 이미 페이지가 존재한다면 우측 상단의 new page 를 통해 생성 가능합니다.
페이지는 마크다운으로 작성 가능하고,
하단에 Edit message에 간략하게 어떠한 수정작업을 진행했는지도 추가 가능합니다. 저장했던 Edit Message 내용은 히스토리에 들어가면 확인 가능합니다.
히스토리 들어가기
히스토리 Edit Message 확인
사이드바 추가하기
페이지 우측에 보면 사이드 바가 있고 하단에 점선 박스(Add a custom sidebar)를 통해 새로운 사이드 바를 생성 가능합니다.
생성해보면 페이지와 다를 것이 없는데 사실 말이 사이드바지 새로운 페이지를 생성하면 우측에 나열시켜 준다고 보면 될 것 같습니다.
작은 걸음이라도 꾸준히