[스터디 후기] Developing Quality Technical Information을 통해 좋은 테크니컬 라이팅의 전략을 배우다

blog main banner

작년 4월에서 11월까지 약 7개월 간 한샘의 TW 주니어들이 모여 Developing Quality Technical Information이란 책을 스터디했습니다. 바쁜 와중에도 열심히 참여해 많은 것을 배우고 큰 성과물도 얻었는데요. 지금부터 그 내막을 공개합니다.

Scripted by
VeryBerry
MD Div.

스터디 목적

테크니컬 라이팅의 목표는 어떤 기술이나 제품의 사용 정보를 쉽고 정확하게 전달하는 것입니다. 이는 모든 라이터들이 익히 알고 있지만, 주니어그룹의 경우 이 목표를 이루기 위한 세부적 지식이 더욱 필요했습니다. 그래서 라이터로서의 능력을 더 함양하고, 궁극적으로는 한샘이 만드는 매뉴얼의 품질을 향상시키고자 IBM의 [Developing Quality Technical Information]을 스터디하게 되었습니다.

스터디 방식

이번 스터디는 구성원 각자가 책 속의 한 챕터씩 맡아 영한 번역본을 만들고 내용을 정리해 미팅 시간에 설명하는 방식으로 진행되었습니다. 자주 접하지 못했던 영한 번역을 제대로 해보고, 동료들에게 가르쳐 주거나 배우면서 자유롭게 토론도 할 수 있었죠. 덕분에 내용도 잘 이해되었고, 최종 산출물로써 멋진 한글 번역본도 만들 수 있었습니다.

예쁘게 제본된 우리의 번역본. 펼쳐볼 때 얼마나 뿌듯하던지요^-^

이 책의 특징

기존에 봐온 책들은 글의 구성 요소, 즉 문단, 문장, 단어와 같은 단위로 가이드라인을 소개했던 반면에 이 책은 기술 정보를 활용하기 쉽게(easy to use), 이해하기 쉽게(easy to understand), 찾기 쉽게(easy to find) 만드는 방법을 대분류로 하여 설명했습니다. 다른 책들이 사전 같다면, 이 책은 해설서 같은 느낌이랄까요? 테크니컬 라이팅이 생소한 사람에게 기존의 책들은 너무 복잡하고 어디서부터 접근해야 하는지 혼란스러워 할 법도 하지만, 이 책은 구체적인 목표를 중심으로 구성되어 많은 사람들이 쉽게 읽을 수 있겠다고 느꼈습니다. 그리고 기술 정보의 범위에 UI 디자인까지 포함되어 현대의 기술 정보 트렌드도 잘 반영된 점이 흥미로웠습니다. 기술 정보 콘텐츠를 제작하거나 UI/UX를 설계하시는 분들 중 테크니컬 라이팅의 배경 지식이 부족한 분들이 있다면 적극 추천하고 싶네요.

스터디를 마치고 얻은 것

라이팅의 원칙에 대해 스터디한 게 오랜만이었는데, 잊었던 내용을 복기하고 놓친 부분도 살펴볼 수 있어 아주 유익했습니다. 매뉴얼을 더 넓은 관점에서 보는 계기도 되었습니다. 짧은 매뉴얼 개발 경험에 기대어 우물 안 개구리와 같이 보다가 이에서 벗어나 시야를 넓힐 수 있었죠.

그 예를 하나 들자면, 정보의 구체성을 높이기 위해 구체적인 예시, 비유나 예제 시나리오를 사용할 수 있다는 것입니다. 보통 예시라고 하면 부연 설명으로 분류해 짧고 간결하게 사용 정보를 전달해야 한다는 측면에서 배제되곤 하는데요. 설명의 대상 자체가 복잡하면 아무리 명확한 명사, 동사를 써서 간단하게 표현하려 해도 그렇게 못하는 때가 있습니다. 너무 낯설어서 간단하게 표현하기 힘들고, 자세히 말하자니 설명이 복잡해 지는 거죠. 이럴 때 적절한 비유나 예시가 하나라도 있다면 긴 말이 필요 없겠죠? 예시는 그렇다 쳐도 비유도 필요한가 생각할 수 있는데, 책에서 다음과 같은 샘플을 통해 그 필요성을 알려주었습니다.

<원문>
<개선문>

복잡한 제품의 매뉴얼을 제작할 때에는 비유와 예시를 적절하게 사용하는 방법을 적극적으로 고려해보고, 어려워도 사용 빈도가 높은 기능은 아예 사용 시나리오를 소개하는 방법도 얼마든지 생각할 수 있음을 배웠습니다.

그 밖에 책을 보다 보니 체크리스트가 수록된 점이 인상적이었습니다. 각 챕터의 마지막에 있어서 앞서 본 내용이 한 눈에 정리되었고, 체크리스트만 따로 뽑아 모아두어도 실제 작업할 때 아주 유용할 것 같았습니다. 그리고 덤으로 UI 레이블을 만들거나 툴팁을 추가하는 데에 있어 도움이 되는 팁도 많이 얻었습니다. 레이블이나 툴팁이 매뉴얼과는 다른 포맷이지만, 그 방향성은 매뉴얼과 비슷했어요. 가끔 SW 매뉴얼을 작업할 때 품질 개선 목적으로 고객사에서 해당 SW에 관한 자문을 구하곤 했는데요, 이번에 배운 내용을 토대로 좀 더 세밀하고 전문적으로 UI를 볼 수 있을 것 같습니다.

여기까지 한샘 TW 주니어들의 스터디 후기였습니다. 책 한 권을 공부할 때마다 라이팅 지식이 쑥쑥 자라는 걸 보며 다음 스터디가 더욱 기대됩니다!

LIST

  • Hansem Story

    중국 우한팀의 오피스 이전

    중국 우한팀의 오피스 이전

    5. 8, 2019

  • Hansem Story

    2019 World IT show 컨퍼런스 참관기 1

    2019 World IT show 컨퍼런스 참관기 1

    5. 3, 2019

  • Posts

    Developing Quality Technical Information_2. 사용자 중심으로 잘 만들어졌는가

    Developing Quality Technical Information_2. 사용자 중심으로 잘 만들어졌는가

    4. 30, 2019