문서를 작성할 때 사용자 중심으로 그리고 사용자가 실제 해야 하는 일 중심으로 작성하라는 이야기는 많이 있습니다. 하지만 기존에 이미 제품 중심으로 작성한 콘텐츠를 어떻게 작업 중심으로 전환해야 하는지에 대한 경험은 접하기 쉽지 않습니다. 대부분 아예 새로 문서를 작성하든지 기존 문서는 그대로 유지하고 조금씩만 수정하는 경우가 많기 때문이죠. 때문에 이번 세션의 경험은 새롭고 신선하네요.
일하고 있는 곳이 스타트업이기 때문에 테크니컬 라이터이긴 하지만 개발자 커뮤니티를 관리하는 업무도 같이 담당합니다. 커뮤니티 구성원은 약 2천여 명인데 이 정도 규모는 테크니컬 라이터가 피드백을 받고 이를 컨트롤하기에 적당한 숫자라고 합니다.
현재 제품은 5가지 분류로 구분할 수 있습니다. 라이브러리, 에이전트, 클라우드, CL, 코어입니다. 때문에 기존 문서는 이 분류를 그대로 가져와서 메뉴로 만들었습니다. 문서에 담긴 콘텐츠 자체는 나쁘지 않았고 문서 구조를 어느 정도 알고 있는 사용자가 문서를 읽고 일을 하는데 어려움이 없었지만 처음 제품을 접하는 경우에는 바로 어려움이 직면합니다. 어디서 어떻게 시작해야 할지를 모르겠다는 것이죠. 이런 문제를 "Cold Start" 문제라고 정의했습니다.
Cold Start 문제는 아래와 같은 내용을 담고 있습니다.
이런 문제가 담긴 문서는 제품을 위한 문서이지 사용자를 위한 문서가 아닙니다.
- 이 제품이 필요한가요, 아니면 저 제품이 필요한가요, 아니면 둘 다 필요한가요?
- 무엇을 먼저 해야 하나요? 다음으로 무엇을 해야 하나요?
- UI가 순서대로 나열되어 있지 않은데 어떻게 해야 하나요?
- 데이터 품질에 대한 테스트 작성은 어떻게 시작하나요?
기존 문서 리소스를 가능한 재사용하기 위해 TOC를 재정의하고 기존 TOC 기준 콘텐츠를 새로운 TOC에 맞게 연결하는 작업을 했습니다. 그리고 빈 콘텐츠를 추가로 작성해서 채우는 것이죠. 한 번에 모든 콘텐츠를 수정하는 것이 아니라 점진적으로 문서를 개선하는 방법을 선택했습니다. 그리고 변경된 구조가 사용자에게 얼마나 만족스러운지 같이 평가했습니다.
콘텐츠 내부 구조도 일부 변경했습니다. 예를 들어 특정한 작업을 수행하는 방법이 n개가 있는 경우에는 탭 형식으로 사용할 수 있는 방법을 나열하고 사용자가 선택해서 해결책을 탐색할 수 있게 제공했습니다.
https://docs.soda.io/soda-library/run-a-scan.html#scan-for-data-quality
처음 시작하는 이들에게 기본적으로 해야 하는 작업을 순서 목록으로 안내하고 있는데 각 단계 콘텐츠를 읽고 나면 다음 콘텐츠에서는 취소선을 표기하는 것으로 TO DO 목록과 비슷한 효과를 주었습니다.
https://docs.soda.io/soda/get-started-roadmap.html
https://docs.soda.io/soda-cl/soda-cl-overview.html
계획하고 실행했던 것 중에 일부는 잘못 판단한 것들도 있었습니다. 프로젝트를 다시 하게 된다면 좀 더 다른 방향으로 진행해보고 싶다고 합니다. 7가지 항목 중에 5가지에 대해서 아쉬움이 남았네요.
점진적으로 문서를 개선하는 것에 대해서는 이게 왜 아쉬움이지 싶은데 Q&A에서 보충을 해주었습니다. 처음에는 계획에 따라 점진적인 개선이 가능할 것이라 생각했지만 진행하게 되면서 전체 문서를 다시 작업해야 했고 점진적으로 뭔가 할 수 있는 여건이 아니었다고 합니다. 아마 문서 담당자가 1명이었기 때문에 정책을 중간에 바꾸는 것이 큰 부담이 없었던 것 같네요.
문서에 대한 만족도 평가는 좋아요/싫어요 지표를 사용했는데 변경 전과 비교해서 64%에서 75%로 좋아요 의견이 늘어났다고 합니다(다른 세션에서도 다루지만 좋아요/싫어요 피드백은 그다지 많은 것을 담지는 못해서).
실제 작업 기간은 6주 정도였지만 꽤 오래전부터 콘텐츠를 작업 기반으로 전환해야 한다는 생각을 해왔고 개별 제품의 콘텐츠를 작성할 때도 그 내용은 작업 기반으로 작성하려고 노력했다고 합니다. 때문에 기존 콘텐츠를 재사용하는 것이 어렵지 않았다고 합니다.
https://youtu.be/N8QSq9mDjFw?si=-CtPlngO1eWl1Qif
Janet Revell
www.flickr.com
