좋은 기술 문서가 필요한 3가지 이유

기록은 힘이 됩니다.

이 글의 원문은 좋은 기술 문서를 만들기 위한 와탭의 여정에서 확인하실 수 있습니다.

첫째, 문서는 기업의 수준을 보여줍니다.

기술 문서를 아무리 잘 써 놓아도 어차피 고객은 보지 않을 것이라 생각하는 사람이 있을 수 있습니다. 문서가 달라봐야 얼마나 다르겠어라고 느낄 수도 있습니다. 하지만 분명 다릅니다. 잘 쓰인 문서와 아닌 문서는 차이가 있습니다. 기업의 공식 문서에 오탈자, 맞춤법, 띄어쓰기가 지켜지지 않은 경우가 있습니다. 고객이 그러한 공식 문서를 보면 어떤 생각이 들까요? '이 기업은 기본적인 어법조차 지키지 않는구나, 과연 서비스는 제대로 할까?'라고 생각할 수도 있습니다. 좋은 기업은 디테일까지 꼼꼼하게 챙겨야 합니다. 그래야만 신뢰성을 유지할 수 있습니다.

둘째, 잘 쓰인 문서는 기업과 고객의 시간을 덜어줍니다.

제품을 사용하다 막히는 부분이 있다고 가정해 봅시다. 가장 쉬운 방법은 고객센터에 문의해서 질문에 대한 해답을 찾는 것입니다. 문제는 정리된 문서가 없거나 혹은 문서에 최신 사항이 제대로 업데이트돼있지 않을 때입니다. 고객 서비스 담당자는 매번 같은 문의가 들어올 때마다 직접 답변을 해줘야 합니다. 정리된 문서가 없기 때문에 담당자를 찾고, 확인하는 과정에서 시간이 소요됩니다. 결국 악순환이 반복되는 셈입니다.

고객 입장에서도 난감하긴 마찬가지입니다. 때로는 답변을 기다리는 것보단 관련 문서를 직접 찾아보는 게 훨씬 빠릅니다. 하지만, 아무리 찾아봐도 해결 방법이 안 나오면 어떨까요? 읽어봐도 무슨 말인지 모르겠다면 당황스러울 겁니다. 심지어 고객센터에 연락해도 바로 답변이 안 온다면 얼마나 답답할까요? 고객 경험에 부정적인 영향을 미치게 될 것입니다.

마지막으로, 문서는 기업의 자산입니다.

물론 좋은 제품을 개발하는 것이 중요합니다. 하지만, 그에 못지않게 개발한 제품에 대한 올바른 사용 방법과 과정을 기록으로 남기는 것 역시 빠질 수 없는 과정입니다. '개발자한테 직접 물어보면 되지 왜 꼭 문서로 정리를 해야 하나요? 너무 바쁘고 귀찮은데요.'라고 생각할 수도 있습니다.

그렇지만 필요할 때마다 개발자에게 직접 물어봐야 한다면 결국 더 많은 비용을 초래하게 됩니다. 더구나 만약 개발자가 퇴사한다면 어떻게 될까요? 개발자가 개인적인 사정이 있어서 당장 연락이 안 된다면 또 어떻게 대처해야 할까요? 기업 규모가 커질수록 기록을 문서로 남겨야 합니다. 담당자에게만 의지하면 긴급한 일이 있을 때 일이 더 커질 수 있습니다.