[프로그래밍] 깃허브 위키를 아시나요??

간혹 TIL 이나 Study, 정보 공유등을 레포지토리에 저장하는 경우가 종종 있습니다.

레포지토리에 저장하는 방식과 위키 방식은 각각 장단점이 있습니다.

우리는 프로그래머로서 같은 문제를 해결할 수 있는 도구 중 더 적합한 도구를 사용하는 것이 좋겠죠.

 

이 글에서는 깃허브 위키 기능과 레포지토리와 차이점에 대해서 알아보겠습니다.

 

위키란

위키는 md 문법을 사용합니다. 레포지토리 - Settings - Features에서 위키를 활성화시킬 수 있습니다.

 

 

 

 

 

위키란 깃허브에서 제공하는 레포지토리의 문서 기능입니다.

주로 라이브러리나 프레임워크의 사용법을 기술하는 용도로 사용됩니다.

반응형

위키 장단점

• 홈, 푸터, 네비게이션 바가 존재한다.
• 네비게이션을 통해 필요한 정보를 빠르게 탐색할 수 있다.
• 수정 권한이 유연해 기여하기 쉽다. (설정에 따라 아무나 수정 가능하다)
• 위키 내용을 추가, 수정해도 잔디를 심을수 없다.
• 폴더 구조를 허용하지 않아 체계적인 관리가 어렵다.
• 사람들에게 익숙하지 않다. (존재하는지도 모른다...)

체계적인 관리가 어렵기 때문에 프로젝트 성격이 일관된 경우 사용하기 적합합니다.

 

레포지토리가 어떤 라이브러리 코드라고 가정한다면 관계자만 레포지토리를 자유롭게 수정할 수 있게 해야합니다.

위키의 수정 권한은 레포지토리와 별도로 적용되기에 권한 설정에서 자유롭습니다.

레포지토리 장단점

• 폴더구조로 다양한 정보를 체계적으로 저장할 수 있다.
• 사람들에게 이미 익숙하다.
• 아무나 수정할 수 없다. (설정에 따라 가능하다)
• 내용을 추가, 수정을 하면 잔디를 심을수 있다.
• 한눈에 필요한 내용을 찾기 어렵다.

레포지토리로 관리하는 방식의 가장 큰 장점은 역시 사람들에게 익숙하다는 것입니다.

다양한 주제의 정보를 공유할 때에도 폴더 구조로 구조화시키기 용이합니다.

 

다만, 가장 큰 단점은 한눈에 필요한 내용을 찾기 어렵다는 것입니다.

여러분, 혹시 정보 공유 레포지토리에 별을 준적 있으신가요??

있으시다면 정말로 필요한 정보를 찾을 때를 생각해 보세요.

 

생각보다 그 과정이 순탄하지는 않았을 겁니다.

이처럼 정보 공유 레포지토리를 뒤지며 원하는 정보를 찾기가 어렵습니다.

---

마치며...

이 글에서 레포지토리로 정보를 공유하는 방식과 위키 방식의 차이점에 대해서 알아보았습니다.

본인의 상황, 프로젝트의 성격에 따라 더 적절한 방식을 택하는데 도움이 되었음을 바랍니다.

 

추천 포스트

[Typescript vs Javascript] 타입스크립트의 종말

[Javascript] Enum 사용하기