핸드북 우선 문화 - 2022/05/30, Monday, UTC
핸드북 우선 문화를 도입하기
😀 핸드북 퍼스트
로캘리 핸드북은 로캘리에서 기술적이지 않은 부분까지 포함한 어떤 일을 시작하기 위한 시작점이 되는 것을 목표로 한다. 신규 입사자의 온보딩부터 사내 커뮤니케이션 방법, 회사의 비젼과 가치, 실무 개발 툴 설정, 빌드 그리고 배포 등 모든 것을 핸드북에 기술 한다. - 본인@2022/04/15
Gitlab이라는 회사가 있다. 회사의 대부분 모든 것을 핸드북이라는 포맷으로 문서화하고 그것을 오픈 소스화해서 public으로 공개하고 있다. 물론 일부 문서는 internal 핸드북으로 관리한다고 한다. gitlab은 장점을 다음과 같이 이야기한다.
핸드북의 장점 (일부 번역)
- 읽는 것은 듣는 것 보다 빠르다.
- 읽는 것은 비동기로 가능하고 다른 팀원을 방해하거나 기다리지 않아도 된다.
- 우리가 일하는 방식을 공개함으로써 이를 읽어본 인재 영입을 쉽게 한다.
- 온보딩에 관한 모든 내용을 기록하므로써 온보딩을 쉽게 한다.
- 다른 팀이 무엇을 하고 어떻게 일하고 있는지를 보고 이해할 수 있어서 협력을 쉽게 한다.
- 핸드북 변경점(git changeset)을 쉽게 알수 있어서 논의가 쉽다.
- 핸드북에 변경 내역을 올리는 것으로 누구나 쉽게 회사 프로세스 변경에 기여할 수 있다.
그리고 gitlab은 고맙게도 open soruce라고 명시했고 handbook minimum set이 공개되어 있다.
😀 문서화
이전의 여러 회사에서 wiki도 써보고 confluence도 써보고 notion도 테스트 드라이브해보고 clickup도 확인해봤는데 여러 툴들은 다음의 2가지 점을 해결하지 못한다.
- 웹에서 편집을 해서 너무 느리다. 충돌이 나면 충돌 처리가 짜증난다.
- 아주 가끔 인터넷 문제로 데이터 확인도 못하고 편집도 못한다.
- 데이터 export가 어렵다. 데이터가 cloud server에만 존재한다.
😀 신규 회사 입사
마침, 반년넘게 휴식을 하다가 금년 초에 C#으로 두어달 백엔드 서버 계약직으로 작업을 해주다 해당 스타트업에 CTO로 입사하게되었다. 옮커니, 좋은 기회다.
이렇게 된이상 핸드북 퍼스트로 간다.
이제 막 A시리즈 투자를 받기 직전의 스타트업이라 업무 workflow가 안정화 되지 않은 상태라 내가 하고싶은대로 모두 변경할 수 있었기에 정식 입사하자 마자 당일날 바로 핸드북을 만들고 문서 작업을 시작했다. 처음에는 나혼자 거의 모든 문서를 작성했지만 이제 좀 내용이 붙어가고 있다.
😀 핸드북 구성과 홈페이지
- engine: hugo - go로 개발한 웹사이트 엔진. 이 블로그도 hugo로 만들어졌다.
- hugo theme: hugo-book - 핸드북에 적합한 테마
- text format: markdown은 본 홈페이지 그리고 개인적으로 사용하는 obsidian에서도 사용하고 있다.
markdown으로 세계정복
- cloudflare pages
그리고 회사 홈페이지도 똑같이 hugo로 리뉴얼중인데 홈페이지 마저 핸드북 페이지에서 수정하고 배포시에 github action으로 해당 .md를 홈페이지로 push해서 그럴싸한 홈페이지 처럼 보이는 theme를 입혀서 출력하고 있다. 모든 것은 핸드북 퍼스트!
😀 핸드북 편집하기
아직 한참 멀어서 부끄럽지만 일부 공개하기로 했다. 핵심 가치, 문화, 복지 등이 난잡하게 정리되어 있지 않다. 😥
- github 웹에디터로 간단히 수정하기 - 데이터가 충분히 쌓이기 전까지 비개발자 분들이 사용
- github 웹에디터로 branch만들고 pr만들어서 수정하기
- vscode로 편집하고 hugo 로컬빌드로 테스트해서 배포하기
😀 인터널 핸드북
현재 로캘리 핸드북은 non-public internal 문서 폴더와 부서 프로젝트를 제외하고는 public 상태다.
끝
gitlab에서 장점을 쏙 빼어 먹고 github를 쓰는게 죄책감이 든다. (…) gitlab 최고입니다.
다음 글은 약 한달 반의 CTO 회고를 써보도록 하고, 프론트엔드(react)/백엔드(java/spring) 개발자를 모십니다. (…)