본문 바로가기

테크니컬 라이팅/WTD 컨퍼런스

WTD 포틀랜드 2023 - 대규모 엔지니어 조직에서 생산성 높은 문서화 프로세스 만들기

반응형

Datadog에는 12명의 테크니컬 라이터가 일하고 있습니다.

일반적인 개론에서는 1명의 테크니컬 라이터가 10~15명 정도 엔지니어와 함께 일하는 것이 이상적이라고 합니다. 미국 통계에서는 약 30명의 엔지니어를 1명의 테크니컬 라이터가 대응하고 있다고 합니다. 하지만 Datadog에서는 2000여 명의 엔지니어가 일하고 있고 12명의 테크니컬 라이터는 이들 2000여 명의 엔지니어와 매일 커뮤니케이션을 진행합니다.

물론 2000여 명의 엔지니어가 모두 테크니컬 라이터 또는 문서화에 긴밀하게 참여한다고 할 수는 없습니다. 그중에 PM이나 팀 리더와 주로 많은 작업을 합니다. 사내 엔지니어 외에도 고객, 사용자, 파트너, 기술지원, 커뮤니티, 세일즈, 번역을 담당하는 이들과도 함께 일을 해야 합니다.

이 정도 규모의 엔지니어링 조직에서 테크니컬 라이터가 제대로 일하려면 생산성을 극대화해야 합니다. 

생산성을 향상하기 위해 5가지 시스템을 도입했는데 그전에 Datadog이 데이터를 수집하고 분석하는데 능숙한 회사라는 점이 무척 도움이 되었습니다.

1. Docs As Code

Datadog 문서팀은 12명의 테크니컬 라이터 외에 웹사이트를 관리하고 지원하는 팀의 긴밀한 지원을 받습니다. 그래서 이미 Docs As Code로 운영할 수 있는 환경을 갖추고 있습니다. 약 5000여 개의 문서와 4000여 개의 이미지가 여러 GitHub 저장소에서 관리되고 있고 개발자와 같은 도구 체인을 통해 작성되고 빌드, 배포됩니다.

2. Focus for writers

12명의 테크니컬 라이터가 각자 분야를 담당하는 구조가 아니라 전체적인 문서에 접근하고 수정할 수 있는 전문성을 가집니다. 물론 특정 정보의 깊이에 대한 차이는 있을 수 있지만 T자형 인재가 되도록 권장합니다.

문서에 대한 수정 요청은 2가지 창구만을 이용하도록 제한합니다. GitHub Pull Request와 Jira card입니다. 모든 요청이 추적되고 적절한 담당자에게 할당할 수 있습니다. 그 외의 긴급한 질문, 요청은 1명의 담당자를 정해서 처리하도록 할당합니다.

3. Standards

엄격하지만 느슨하게 표준을 관리합니다.

문서가 5가지 표준(순서 목록, 사용자 목표 지향, 안정적인, 시간이 지나도 정확한, 일반적인)을 지킨다면 어떤 형태의 문서든 문서로 인정합니다. 이런 표준은 제약이 아니라 가이드레일로 동작합니다. 문서 작업에 도움을 주고 문서 변경의 기준이 됩니다.

4. "Docs matter" mindset

조직 내에서 문서화가 중요한 것이라는 것을 새기도록 합니다. 예를 들어 기술지원팀에서 사용하는 문서는 공개된 문서여야 하고 기술 지원 과정에서 문서 내 문제를 발견하면 이를 반영할 수 있도록 조치해야 합니다. 어디서든 문서에 대한 피드백을 중요하게 여기도록 하는 것입니다.

현장에서 움직이는 세일즈 조직에서도 문서에 관심을 가지고 피드백을 줄 수 있게 합니다. PM의 경우에는 문서 초안을 검토하고 피드백을 빠르게 줄 수 있는 프로세스를 마련합니다. 그 외의 엔지니어들이 자발적으로 문서에 대한 피드백을 보내주면 그것이 잘못된 내용이라고 하더라도 최대한 친절하게 대해줍니다.

5. Building a strong, resilient team

Datadog에서 테크니컬 라이터를 뽑을 때는 너무 완벽을 추구하는 이들은 선발하지 않습니다. 부족한 문서를 빨리 배포하고 지속적으로 업데이트하는 것을 권장합니다. Datadog 만의 독특한 프로그램이 있는데 엔지니어 대상으로 문서팀에서 함께 할 수 있는 기회를 제공하고(약간의 교차 근무 같은) 3주 정도 문서팀원으로 일하게 하는 것입니다. 그리고 문서팀에서의 일이 적성에 맞다고 느껴진다면 문서팀에 고정으로 합류할 수 있는 기회를 줍니다.

 

마지막 조언은 여러분의 문서는 완벽하지 않고 찾기 어렵고 어떤 정보는 찾을 수 없습니다. 이를 인정하고 나아가세요~

 

https://youtu.be/gdsmHokNdIs

 

728x90