Docs for Developers
바티, 콜라이센, 램본, 누네즈, 워터하우스 저/하성창 역
#북리뷰
아쉽게도 우리나라에서 technical communication 분야는 여전히 작다.
졸업 후 처음 이 일을 시작한 10년 전에도 지금도 테크니컬 라이터(technical writer)라고 말하면 무엇인지 모른다.
우리 학교 내 전공과목 설명이다.
The tech communicators know the importance of precision in writing for the sciences and other specialized fields. They organize information like pros and understand how to present data and text efficiently and effectively. They make technical details accessible, appreciative that knowledge can’t advance without clear communication.
- 출처: http://english.utk.edu/english-major/
사실 특별한 뜻이 있어서 선택한 전공은 아니었지만, 길지 않은 인생에서 제일 잘한 선택 중 하나라고 생각한다.
최종 사용자를 위한 매뉴얼, 기업 보고서, 브로슈어 등을 작성하는 것으로 시작해서, 핸드폰 UI를 작성하고, 개발 문서를 지원하고 있는 지금까지 여전히 난 내 전공과 직업이 매우 자랑스럽고 또 그만큼 좋아한다.
Technical writer는 단순히 글만 잘 쓰는 사람이 아니다.
쓰려고 하는 주제를 빠르게 이해하는 능력도 필요하며
그래서 배우고 도전하는 것을 두려워해서도 안 되며
사용자의 흐름을 파악해 문서를 구성할 수 있을 만큼 논리적이어야 하며
팀원들의 빨간펜을 담대히 받아들일 수 있어야 하며
독자의 이해 능력을 고려하며 제품을 제공하는 회사(또는 개발자)의 의견을 잘 반영해야 하기 때문에 커뮤니케이션 능력도 아주 중요하다.
이 책 역시 글쓰기 자체를 다루진 않는다. 어떻게 소통해야 하며 그 과정에서 무엇이 중요하며 어떤 문서를 어떻게 써야 하는지를 알려준다.
챕터 1 - 독자 이해하기
챕터 2 - 문서화 계획하기
챕터 3 - 문서 초안 만들기
챕터 4 - 문서 편집하기
챕터 5 - 샘플 코드 통합하기
챕터 6 - 시각적 콘텐츠 추가하기
챕터 7 - 문서 배포하기
챕터 8 - 피드백 수집하고 통합하기
챕터 9 - 문서 품질 수정하기
챕터 10 - 문서 구조화 하기
챕터 11 - 문서 유지 관리 및 지원 중단하기
부록 A - 국내 테크니컬 라이팅은 어떨까요?
부록 B - 전문가를 고용해야 하는 이유
부록 C - 참고 자료
'강아지 음성 번역 서비스'를 만드는 개발팀의 스토리를 따라가며 각 단계별 기술 문서 작성하는 방법을 설명한다. 거기에 문서 배포, 품질 측정, 유지 관리 등에 관한 정보도 함께 주어 실무에 적용할 수 있는 부분들이 많았다. 개발문서를 쓰는 테크니컬 라이터 또는 문서 작업에 관심이 많은 개발자에게 추천한다.
그리고 책 후반부에 실린 국내 테크니컬 라이터의 현실(?)과 인터뷰 역시 위로, 배움, 도전을 주는 이 책의 큰 장점인 것 같다. 인터뷰를 읽으면서 다시 한번 느꼈지만 이 작디작은 분야에서 참으로 훌륭하신 테크니컬 라이터가 많다.
책후기와는 별개로 사견을 덧붙이자면-
Technical writer가 개발 문서 쪽에 (또는 IT에) 국한된 것이 아닌데, 꼭 그렇게 이해되는 것 같아서 조금 아쉬운 면도 있다. 또한 writer라고 해서 글만 쓰는 것이 아니라 writer 보다는 communicator가 더 어울리는 표현이라고도 생각한다.
아 그냥 가기 아쉬우니까-
개발 문서를 작성하는 IT 계열의 테크니컬 라이터 한정이지만, LINE에서 진행한 테크니컬 라이터 인터뷰 영상도 첨부한다.
