본문 바로가기

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

WTD 프라하 2022 - 독자와 관계 구축을 통해 문서 개선하기

반응형

문서 이해관계자(독자)와의 관계 구축을 통한 콘텐츠 개선하기가 주제입니다. Taylor는 Splunk에서 테크니컬 라이터로 일하고 있습니다.

4년 전 어떤 문서를 개선한 경험에 대해 이야기를 시작합니다.
기존 문서는 뭔가 불편함이 있었다고 합니다(정확하게 어떤 문제였는지는 언급하지 않고 있습니다). 그래서 이런 피드백을 수용하고 개선하기로 결정하고 PM과 어느 정도 범위에서 진행을 할지 협의했다고 합니다.

아래와 같은 점을 수정했습니다.
- 태스크 기반 가이드 문서 작성
- 문서, SDK, 예제 저장소에서 사용하는 용어 표준화
- 개발자가 활용할 수 있는 도구, 리소스 소개
- 업데이트되지 않고 정확하지 않은 콘텐츠 제거

프로젝트의 결과로
- 정확하고 최신 코드에 맞는 가이드 문서를 작성했고
- 여러 곳에 흩어져있던 관련 정보를 한 곳에 모았습니다.

여기까지 하면 모범적인 사례구나 싶은데
하지만 의외로 반응이 좋지 않았다고 합니다.
- 사용자는 만족스럽지 않았고
- 그 이유는 사용자가 실제로 사용하는 방식과 문서의 접근 방식이 달랐던 것이 문제였다고 합니다.

 


이런 일이 발생한 원인 중 하나는 주로 문서에 대한 요구사항을 실제 이해관계자(독자)가 아닌 PM이나 관계자를 통해 간접적으로 받는 데 있었습니다. 설계 기준으로 문서를 정리했는데 이게 실제 사용자 요구사항과는 거리가 있었다는 거죠.


그래서 문서의 개선을 위해 접근방식을 변경했습니다.
- 실제 독자로부터 요구사항을 수집하고
- 지속적으로 콘텐츠 품질을 높이기 위해 그들과 관계를 유지하며
- 이런 접근 방식 변화의 효과를 측정하기로 했습니다.

기술지원팀을 통해 문서 관련 피드백을 제출한 독자와 직접 만나고 관계를 만들어갔습니다.

같은 회사 Kevin Hwang의 작년 강연을 언급합니다. 아직 못보셨다면 같이 봐도 좋을 것 같네요.
피드백과 관계 구축의 가장 큰 차이는 관계 구축은 사전 예방적인 효과를 만들 수 있다고 합니다. 좀 더 능동적인 접근 방식이라는 거죠.

2021.11.11 - [테크니컬 라이팅/WTD 컨퍼런스] - WTD 프라하 2021 - 문서에 대한 피드백 받기

 

1:1 미팅은 코로나 덕분에 모두가 온라인상의 미팅을 부담스럽지 않게 생각해서 쉽게 진행할 수 있었다고 하네요. 커뮤니티 채널을 활용하는 방식에서는 사용자의 질문에 답변을 하면서 새로운 콘텐츠 링크를 답변과 연계할 수도 있었다고 합니다.

세션 후반부에 이벤트 관련 내용이 언급됩니다. 여기서부터는 테크니컬 라이터보다는 데브렐 담당자와 살짝 비슷해지는 것 같네요. 컨퍼런스 등에서 직접 발표를 할 기회가 된다면 더 많은 관계를 만들 수 있는 기회가 됩니다.
이벤트(커뮤니티)에서 새로운 리소스를 발굴하는 등의 방법에 대해서는 '기업의 성공을 이끄는 Developer Relations'을 참고하는 것을 권해드립니다.

https://m.hanbit.co.kr/media/books/book_view.html?p_code=B9102351881 

 

이런 관계 구축이 중요한 이유 중 하나는 같은 문제에 대해서 서로 다른 관점을 가지고 접근하는 사용자가 있다는 것입니다. 이런 목소리는 커뮤니티가 아니면 얻을 수 없는 피드백이죠.
간혹 심한 말로 피드백을 보내는 경우도 있는데 이럴 때 이런 피드백이 테크니컬 라이터 개인에 대한 감정 표현이 아니라 제품에 대한 관심이라는 것을 생각해야 합니다. 그렇지 않으면 이런 피드백을 수용하는 것이 쉽지 않겠죠.

이러 노력에 대한 성과 측정은 다섯 가지입니다.

(딱히 특별하지는 않네요).
- Content views
- Support ticket numbers
- Doc feedback sentiment(만족도)
- NPS(Net Promoter Score, 순수 추천고객 지수) scores (문서 내에서 매번 측정하는 건 아니고 서베이 형식으로 데이터를 수집하는 듯합니다)
- Doc links(커뮤니티 내에서 글을 작성할 때 문서에 대한 링크를 얼마나 활용하는지)

 

https://youtu.be/3CiPXvawuow

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

 

Taylor Cole

Explore writethedocs' photos on Flickr. writethedocs has uploaded 2656 photos to Flickr.

www.flickr.com

 

728x90