본문 바로가기

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

WTD 포틀랜드 2024 - 내부 기술 문서는 어떻게 관리하나요?

반응형

스트라이프는 2010년 시작해서 몇 년 동안 작은 규모(수 백 명 수준)의 스타트업이었습니다. 2016년부터 회사의 규모가 커지고 제품도 늘어나게 됩니다. 특히 코로나 기간 동안 온라인 상거래가 늘어나면서 스트라이프 사용자 역시 빠르게 늘어나게 됩니다.



조직이 성장하면서 내부 문서에 대한 불만이 커져갔습니다. 이전에는 누가 어떤 작업을 했고 어떤 문서가 어디있는지 알 수 있으니 큰 문제가 아니었는데 조직이 커지면서 점점 문제로 자리 잡았습니다. 스트라이프에서는 2년에 한 번씩 내부 개발자를 대상으로 설문을 진행합니다. 어떤 것이 개발에 방해가 되는지 확인하기 위한 용도입니다. 설문 결과 내부 문서에 대한 불만이 많음이 드러났습니다. 불만을 몇 가지로 정리해 보면 다음과 같습니다.

- Fragmentation(단편화)

팀마다 문서를 관리하는 방식이 달랐습니다. 필요한 문서를 어디서 찾아야 할지 몰랐고, 작성한 문서를 어디에 올려야 하는지도 혼란스러웠습니다. 

다른 플랫폼에서 문서를 관리하는 이유를 좀 더 깊이 살펴보면 나름의 이유가 있습니다. 플랫폼마다 제공하는 기능이 다르고 팀마다 원하는 문서 관리의 형태가 다르기 때문이죠.

그래서 Trailhead라는 내부 문서 관리를 위한 플랫폼을 새로 만듭니다. Trailhead를 공개할 계획은 없다고 합니다. 현재 상태는 내부 요구사항에 너무 깊이 관여되어 있기 때문이라고 하네요.

(세일즈포스의 Trailhead와는 상관이 없다고 합니다. 그냥 이름을 만들다 보니 그렇게).

- Freshness(신선함)

신선한 문서를 유지하기 위해서는 지속적인 노력이 필요합니다. 이를 해결하는 유일한 방법은 주기적으로 관련 전문가가 문서를 검증하는 것입니다. 검증 과정을 통과하지 못하면 문서는 신선하지 않은 것으로 판단되고 감추어집니다. 때문에 문서를 계속 유지하기 위해서는 지속적으로 문서가 검증에서 통과되어야 합니다.

- Discoverability

각기 다른 플랫폼(25개 정도)를 없애는 것은 아니고 원하는 것을 찾고 연결될 수 있도록 제공합니다. 점차적으로 플랫폼의 수는 줄여나가겠지만 당장은 아니라는 이야기네요.

golinking 방식을 사용하고 있다고 합니다.

- "Doc quality"

내부 문서는 대부분 테크니컬 라이터가 아니라 엔지니어들이 작성하기 때문에 문제 해결에 초점을 맞추도록 하고 있습니다. 글을 쓸 때 부담이 되지 않게 템플릿을 제공하고 따라갈 수 있도록 가이드합니다.

 

https://youtu.be/DxbXKLl-URo?si=3bTdZ903aPk4g3ie

 

https://flic.kr/p/2pMvxhF

 

Alistair Gray - Sociological Concerns

 

www.flickr.com

 

728x90