시리즈: 개인공부 (9개 글)
인트로
블로그를 Github page를 이용해서 관리하고 있는데, 별도의 레포라던지 다른 위키 호스팅과 관련된 기능이 아니라 안정적으로 지식을 쌓아서 문서화 할 수 있는 방법을 모색하던 중.
Github 레포 안에 프로젝트를 설명하기 위한 위키를 만들 수 있다는 것을 알게 되었다.
README만 잘 쓰면 된다는 생각도 했었지만 체계화된 문서 (NestJS와 Prisma의 공식문서가 영감을 줌)는 확실히 엄청난 장점이라는 생각을 했기 때문에 README와 블로그 포스팅에서 멈추는 것이 아니라, 지식을 카테고리 별로 쌓아 올릴 수 있는 Wiki를 만들어보고자 했다.
또한 추후 무언가 개발하게 되었을 때 위키를 다뤄본 경험 또한 문서화의 경험이라고 생각하기에 바로 추진해봤다.
사실 위키 보는 것을 좋아해서, 심심할 때 아무나 들어와서 간단히 지식을 얻어갈 수 있는 그런 wiki를 꿈꾸고 시작한 것도 있다.
고민했던 내용
Q. 블로그와 위키의 성격이 겹치는건 아닐까?
A. 이는 중복되는 지식 관리의 성격이 아니다!
블로그는 시간의 흐름과 관련된 정보 혹은 학습한 내용, 후기에 대한 이야기가 메인이 되지만(시계열적)
위키는 하나하나 쌓아가며 정보의 확장을 이룰 수 있다는 방향성이 다르다.(구조적)
Github wiki ??
왜 github wiki를 선택했을까
- 블로그 레포를 조금 더 효율적으로 사용하기 위해서
- 위키 기능을 우선 사용하면서 블로그에 학습 내용을 정리하는 만큼 정보 연관도가 높다는 판단
- 추후 문서화 과정에서 어떤 부분을 어떻게 하면 좋을까 라는 경험
- 로컬 작업 가능 (장점)
장점
별다른 설정이 크게 필요하지 않다.
- 레포 설정에서 wiki만 활성화한다면 해결
- 별도 설정 없이 깔끔깔끔하게 위키가 생기는 모습이다.
- 레포 이름 +
.git이라는 버전 관리를 지원한다는 점 또한 매력적. - 마크다운으로 작성하는 것이 익숙하다.
단점
- 측면 사이드바를 고쳐야하는데, 해당 부분은 html을 통해서 진행해야 했다.
<details>
<summary>닫혀있을 때 보여질 내용</summary>
<ul>
<li><a>위키 링크</a></li>
</ul>
</details>
이런 느낌으로 진행해야 하는데 해당 부분에 대해서 생각해야 하는 부분이 많다.
- 문서 연결과 관련해서 직접 하나하나 기억해서 연결해야 하는 것 같은 느낌
추후 규모가 커지게 된다면, 해당 부분은 확실히 엄청난 단점이 되지 않을까 싶은 느낌이다.
현재는 깃 블로그 레포와, 추가적으로 옵시디언에서 그래프를 통해 컨텐츠를 관리할 계획.
- 권한 설정에 대한 불안감
퍼블릭 레포에 올려둔 만큼, 위키를 누가 반달(테러)한다면 어떻게 대처해야 할 지.
wiki 자체의 설정으로 collaborators와 관련된 설정이 있다는 것을 확인했다.
안심
고도화 아이디어
git 과 옵시디언을 적절히 활용한다면, 언제 어디서든지 편하게 보고, 편하게 수정하고 또 편집 생산성을 높일 수 있지 않을까?
혹은 집에서 사용하고 있는 NAS를 중간 서버로 이용하여, github action을 사용할 수 있다면 이 또한 좋을 것 같다!
다만 지금 단계는 지식/정보 관리 및 체계화에 힘쓰는 방향으로.
결론
뭔가 심플한 느낌.
초반에는 욕심내지 말고 HTML 을 간단한 요소에 적용하고, 내용 확보에 집중!
평소에 위키를 즐겨보는 입장에서, 이런 하나하나 디테일을 따지다보면 주객전도가 되는게 아닐까 싶은 느낌이 조금 드는데 어쩌지 싶은데 우선 하고싶은 일 열심히 해보기로!
하지만 지식은 깔끔하게 나누는 것, 내가 나누고 싶은 형태로 나누는 것
나눈다는 행위에 의미를 두고 열심히 공부해서 남 주자
화이팅화이팅
-뱅-