brunch

You can make anything
by writing

C.S.Lewis

by Sunny Nov 21. 2022

애플 공식 문서는 어떻게 구성돼있나?

글로벌 빅테크 회사가 문서를 대하는 자세

애플에서 근무할 때 문서화가 참 잘돼 있다는 생각을 했다. 그때는 미처 몰랐다. 문서화가 잘돼 있는 회사와 아닌 회사 차이가 이렇게 크다는 걸 말이다. 제품을 잘 만들면 굳이 문서화가 필요하지 않다고 주장하는 사람도 있다. 나는 동의하지 않는다. 꼭 기술 문서가 아니더라도, 회사에서 중요한 핵심 정보를 문서화하면 활용도가 높다. 커뮤니케이션 비용을 줄일 뿐만 아니라, 신규 직원 온보딩에도 크게 도움이 된다.


가장 유용한 문서는 부서의 공식 용어집이었다. 어느 회사나 그렇지만 신규 직원들이 회의에 들어가면 온통 알 수 없는 용어들 투성이다. 특히 애플같이 외국 회사는 팀 회의에서 영문 약어를 쓰는 경우가 정말 흔하다. 예를 들면, 애플 온라인 스토어는 Apple Online Store라고 매번 풀어서 말하지 않는다. AOS라고 앞 글자를 딴 약어를 부르는 식이다. 이런 식으로 약어가 많다 보니 하나하나 가르쳐 주기도 힘들다. 그렇지만 굳이 매번 설명해줄 필요도 없었다. 사내 공식 용어집에 이미 설명이 나와있기 때문이다.


애플 문서에서 다른 좋은 점이라면 문서 변경 히스토리가 하단에 모두 기록돼있다. 같은 토픽의 주제라도 세부 사항이 변경되기 마련이다. 지난번에 봤을 땐 분명히 이 내용이 없었는데 언제 바뀐 거지? 의아하면 히스토리를 확인해본다. 정확히 언제 어떤 내용이 추가 혹은 삭제되었는지 알 수 있다.


그렇다면 문서가 변경되었다는 사실 자체는 어떻게 알까? 설명을 조금 덧붙이자면 문서 자체에 템플릿이 있다. 이 문서는 어떤 제품, 어떤 팀이 봐야 할 문서인지 카테고리가 분류돼있다. 사내 시스템에 들어가면 매일 아침 공지사항에서 우리 팀과 관련된 문서 중 새로 업데이트되거나 추가된 문서가 어떤 게 있는지 확인할 수 있다.


애플에서 이 모든 정보 구조화 작업을 테크니컬 라이터가 하는지는 잘 모르겠다. 애플의 기술 문서를 보면서 느낀 점은 테크니컬 라이팅이 단순히 글 잘 쓰거나 영어만 잘한다고 되는 게 아니라는 것이다. 흩어진 정보를 어떻게 쪼개고, 모으고, 전달할지 구조를 짜는 능력이 정말 중요하다. 특히 정보의 양이 방대해질수록 난이도는 더 높아질 것이다. 이러한 테크니컬 라이터 역량과 문서화를 중요시하는 회사 지원이 뒷받침되어야 하지 않을까? 그래야만 정보를 구조화하고, 활용하는 선순환이 비로소 이루어질 것이다.

매거진의 이전글 테크니컬 라이터 어려운 점 3가지
브런치는 최신 브라우저에 최적화 되어있습니다. IE chrome safari