본문 바로가기

테크니컬 라이팅

WTD 포틀랜드 2021 요약 - 오픈 소스 프로젝트 문서화에 참여해보세요.

Abigail McCarthy는 VMware 오픈 소스 기술 커뮤니케이션 매니저입니다. 여러 가지 일을 하겠지만 주로 오픈 소스 프로젝트 문서화에 참여하고 커뮤니티를 지원하는 역할을 합니다. 기존에는 제품 매뉴얼을 전담했던 테크니컬 라이터였습니다.

 

많은 기술 기업이 그렇듯이 VMware도 오픈 소스에 많은 투자를 하고 있습니다.

https://www.vmware.com/opensource.html 에서 참여하고 있는 오픈 소스 프로젝트 목록을 확인해볼 수 있습니다.

 

Guide to getting started in open source

https://youtu.be/3prrgLv4qt4

오픈 소스 프로젝트는 문서화를 위한 도움이 항상 필요합니다.

발표자처럼 풀타임으로 문서화 작업을 지원하는 팀이 있다면 모르지만 그렇지 않다면 문서화가 쉽지는 않습니다. 물론 인기 있는 프로젝트라면 자발적으로 참여하는 분들이 많아서 괜찮겠지만 모든 프로젝트가 그런 건 아니죠.

국내의 경우 오픈 소스 프로젝트 자체가 그렇게 큰 규모로 진행되는 것은 없고 대부분 특정 기업 주도로 진행되는 것이라 기업 내에서 작업을 할 겁니다. 오히려 번역 프로젝트가 커뮤니티 기반을 진행되는 것이 많습니다.

 

예를 들어 요즘 뜨거운 쿠버네티스 같은 경우 한글화 가이드를 별도로 작성하고 번역을 위한 마일스톤까지 관리합니다.

https://kubernetes.io/ko/docs/contribute/localization_ko/

 

쿠버네티스 문서 한글화 가이드

쿠버네티스 문서 한글화를 위한 가이드 팀 마일스톤 관리 쿠버네티스 문서 한글화팀은 커뮤니티의 현지화 가이드에 따라 한글화를 위한 팀 마일스톤과 개발 브랜치를 관리한다. 본 섹션은 한글

kubernetes.io

테크니컬 라이터가 오픈 소스 프로젝트에 참여하면 아래와 같은 것을 얻을 수 있습니다.

  • 포트폴리오: 요즘 테크니컬 라이터 모집 공고를 보면 포트폴리오를 요구하는 곳이 많습니다. 하지만 테크니컬 라이터로 매뉴얼 작업을 해보지 않았다면 마땅히 채울 항목이 없죠. 어때 오픈 소스 프로젝트에 참여한 이력을 써넣으면 도움이 됩니다.
  • 새로운 기술: 아무래도 회사에서 일하는 경우에는 특정 기술에 묶여 있는데, 오픈 소스는 원하는 기술을 좀 더 깊게 들여다보고 글을 쓸 수 있다는 것이죠. 물론 그만큼 공부도 필요합니다.
  • 네트워크: 규모에 따라 다르겠지만 적극적으로 참여한다면 네트워크를 넓히고 그 속에서 새로운 기회를 추천받을 수도 있습니다.
  • 커리어: 이건 뭐 포트폴리오랑 비슷하지만~~

오픈 소스 프로젝트에 참여하는 것이 1회성으로 끝나는 것이 아니라서 어느 정도 원하는 목표(위에서 설명한 것들)가 있어야 장기적인 참여가 가능하다고 합니다. 그래서 명확한 목표를 정하고 시작하는 것이 좋다고 하네요.

 

참여할 오픈 소스 프로젝트를 찾을 때는 최근 활동이 있는 프로젝트를 찾아야 합니다. 참여가 없다면 물어봐도 답해줄 사람이 없을 수도 있고 해서. 깃허브에서 최근 활동은 바로 확인할 수 있으니 참고하라고 합니다.

그리고 행동 강령(Code of Conduct)나 참여 가이드 문서가 있는지도 확인해야 합니다. 규모가 작은 프로젝트는 아직 이런 준비가 되어 있지 않을 수도 있습니다. 여러분이 이런 문서를 만들어주어야 할지도~

 

테크니컬 라이터 중에서 SCM(깃이나 깃허브)를 사용해보지 않는 분들은 뭔가 어려워 보여 참여하기를 꺼려하는데, 그냥 이슈를 등록하는 것만으로 시작할 수 있고 문서 작성을 위한 도구를 따로 제공하는 곳도 있어서 그리 어렵지 않습니다.

특히 번역 같은 경우는 별도 번역 솔루션을 통해 번역에만 집중하도록 지원하기도 합니다.

 

작은 것부터 참여해보세요.

오픈 소스 프로젝트 문서를 읽고 오타를 이슈로 등록하는 것부터 시작할 수 있습니다.

커뮤니티에 참여하고 문서 관련 이슈(이런 이런 문서가 필요해요~ 같은)를 읽고 대응하면서 좀 더 깊게 참여할 수 있습니다.

 

https://twitter.com/writethedocs/status/1386753443595948037

728x90
반응형