본문 바로가기

테크니컬 라이팅

WTD 프라하 2021 - 문서의 구조가 튼튼한지 살펴보기

Lana Brindley는 Timescale이라는 시계열 데이터 솔루션 기업의 테크니컬 라이터 겸 관리자입니다. Timescale이라고 해서 일정 관리 소프트웨어인가 싶었는데 잘못짚었네요. 

세션 시작에 Bundjalung(한국어 표기는 분달롱) 이야기가 나옵니다. 올해는 호주 WTD 이벤트가 취소되어서 아마 그때 하려고 했던 이야기를 꺼낸 것이 아닌가 싶습니다. WTD 세션 중 해당 지역에서 나온 이들은 간혹 그 지역의 이슈나 하고 싶은 이야기를 하더라구요. 하여간 분달롱은 호주 원주민이라고 합니다.

https://en.wikipedia.org/wiki/Bundjalung_people

 

https://youtu.be/Gm-0IIvWLmE

세션 중간에 나온 표 중에 독자에 대한 정의가 인상적이었습니다. 보통 "독자=사용자"라고 생각하기 쉬운데 사용자 중에서 문서를 읽지 않는 대부분을 제외해야 하고(물론 소프트웨어 문서는 보지 않고서 사용법을 알아낼 방법이 없기 때문에 대부분 문서를 보긴 합니다만) 사용자는 아니지만 문서를 보는 대상자(영업, 관리자 등등)도 있다는 겁니다. 때문에 실제 독자의 유형과 어떤 유형의 독자가 많은지 확인하고 그들에게 적절한 정보를 제공해야 한다는 것이지요.

사용자의 유형을 확인하게 되면 그들이 궁금해하는 질문을 확인할 수 있습니다. 예를 들어 "드릴을 사용하는 법"이라는 주제가 있는데 사용자가 가지고 있는 이슈는 침대를 벽에 고정시키는 것이라면 "드릴"이라는 키워드를 바로 찾지 못할 수도 있다는 거죠. 때문에 키워드는 "침대"가 되어야 하고 "침대를 벽에 고정시키는 법"에서 드릴에 대한 이야기가 나와야 한다는 것입니다.

https://twitter.com/writethedocs/status/1444969314113708033

728x90
반응형