테크니컬 라이팅에 대한 중요성은 계속해서 대두되고 있습니다. 구글은 테크니컬 라이팅 관련 강의와 리소스를 제공할 정도이죠. 현재 우리나라에서는 테크니컬 라이팅보다는 테크니컬 라이터, 테크니컬 에디터라는 직업군으로 더 알려져 있습니다. 테크니컬 라이팅은 사회적 활동을 하고자 하는 사람들 모두에게 필요한 능력이며 우리나라와 같이 고도의 IT기술 및 디지털 시대를 살고 있다면 글쓰기의 중요성은 더욱 커집니다.
테크니컬 라이팅은 정보의 전달과 소통으로 활용되는 비즈니스 E-Mail부터 시작해 보고서, 기획서, 사업계획서, 기술문서, 기술 가이드 그리고 요구 사항 정의서에 이르기까지 업무적으로 써야 할 모든 문서에 활용됩니다. 이메일을 작성할 때 본문을 구조화하여 간결하게 작성하거나, 사내 게시판에 글을 쓸 때 특정 메시지를 파급력 있게 전달하는 것 모두 테크니컬 라이팅을 하고 있다고 볼 수 있습니다.
1. 테크니컬 라이팅이란?
테크니컬 라이팅(technical writing)은 좁은 의미로는 과학 기술 정보를 정확하고 효과적으로 전달하기 위한 문서 작성 기술을 뜻합니다. 넓은 의미로는 모든 유형의 글을 보다 분명하고 알기 쉽게 전달하는 글쓰기를 통칭하기도 합니다. 테크니컬 라이터는 소설과 같은 창작 글쓰기를 제외한 모든 유형의 글쓰기에서 그 뜻을 분명하고 쉽게 독자들에게 전달하는 것을 목표로 갖고 있습니다. 즉, 개발자 중심의 기술 관련 용어, 설명을 독자가 쉽게 이해하도록 콘텐츠를 가공, 배포, 관리하면서 프로젝트 초기 단계부터 문서화 작업을 계획하고 수행하는 것을 말합니다.
2. 일반 글쓰기와의 차이는?
테크니컬라이팅은 큰 범주에서 보면 글쓰기(Writing)의 한 부분에 속합니다. 작가가 독자와 커뮤니케이션하기 위한 방법으로 글을 쓴다는 부분은 같습니다. 그러나 테크니컬 라이팅과 일반 글쓰기의 가장 큰 차이는 ‘사실만을 다루는가’와 ‘감정에 호소하는 글인가’ 입니다. 테크니컬 라이터는 작가 본인의 창작이나 생각을 제외하고 사실만을 서술해야 합니다. 즉, 일반 글쓰기가 자유로운 형식을 바탕으로 하여 상상 혹은 생각과 같은 주관적 입장까지 담고 있는 글이라면 반대로 테크니컬 라이팅은 객관적인 사실을 근거로 형식에 맞추어 작성하게 됩니다. 이러한 특성 때문에 수식어가 거의 사용되지 않고, 모호한 표현을 사용해서도 안됩니다.
3. 글 쓰기 전, 필수 고려사항
본격적인 테크니컬 라이팅을 하기 전에 필수로 고려해야 할 사항은 바로 ‘독자’를 파악하는 것입니다. 내가 작성하는 문서를 가장 많이 열람하고 사용할 사람은 누구인지, 그 사람이 해당 기술 혹은 내용에 대한 기본 지식이 얼마나 있는지 그 수준을 파악한 뒤에 글을 작성해야 합니다. 만약 일반 사용자 그리고 초보 개발자를 위한 기술 문서라면 용어 자체가 쉬운 용어로 작성되어야 합니다. 그리고 사용자에게 반드시 필요한 내용으로만 구성되도록 글을 작성해야 합니다. 많은 정보를 제공하는 것도 좋지만 과도하게 많은 정보를 제공할 경우 비교적 높지 않은 수준의 독자들은 해당 정보가 본인에게 맞는, 필요한 정보인지 생각하면서 시간을 허비하게 됩니다.
독자를 설정했다면 목적도 고려해야 합니다. 기술 문서를 작성한다면 독자가 언제 어떻게 해당 문서를 활용하는가를 생각하고 작성해야 합니다. 제품을 소개하는 것이 목적인지, 제품을 사용하는 데에 초점을 맞춘 문서인지에 따라 문서의 방향은 달라질 수 있습니다. 또한 독자의 문화와 모국어에 따라서 올바른 관용구와 표현을 사용할 때 이해도를 높일 수 있습니다.
4. 테크니컬 라이팅의 5단계
1) 기획 (Plan)
문서의 주제와 발행 일정 등을 결정합니다.
가장 먼저 문서 작성의 범위를 정의해야 합니다. 산출되는 문서의 종류 혹은 콘텐츠가 다양한 경우 이를 고려한 문서 작성 범위를 정의합니다. 만약 다국어 버전이 필요하다면 번역 언어도 함께 정의합니다. 문서 이해관계자들 사이에서 초안 작성자와 테크니컬 라이터, 피어 리뷰 (Peer Review) 진행자, 문서 최종 승인자 등을 정의해야 합니다. 문서 작성 도구와 파일 형식은 물론이고 초안 전달, 1~2차 검수본 전달, 피어 리뷰 완료, 최종 문서 배포 등의 일정을 수립하면서 기획 단계에서 문서 작성 타임라인과 산출물에 대한 가이드라인을 갖추게 됩니다. 작성하고자 하는 주제와 관련된 정보를 수집하고 진행 상황을 추적하는 것도 이 단계에 포함됩니다.
2) 구조화 (Structure)
기획 단계에서 수집한 정보들을 구조화하여 초안 작성자와 테크니컬 라이터는 문서의 목자를 함께 구성합니다.
문서의 구조화는 레퍼런스 문서를 잘 문석하고 가독성과 독자의 편의성 등 다양한 요소를 고려해야 합니다.
3) 문서 작성 (Write)
전달한 내용을 모두 넣는 것에 집중해 초안을 작성합니다.
국내의 경우 외국과 비교했을 때 문서화의 중요성에 대한 인식이 자리 잡혀 있지 않기 때문에 문서 작업은 개발과 별개의 부차적인 업무로 여겨지는 경우가 많습니다. 각 개발 세부 단계마다 문서 작성을 뒤로하고 개발 및 프로젝트 업무를 완료한 뒤에 문서 작성을 시작한다면 이슈 대응, 긴급 프로젝트 투입 등과 같은 이유로 결국 완성도 낮은 문서가 만들어집니다.
문서 작성은 내용이나 난이도에 따라 다르지만, ISO/IEC 표준에 따르면 문서 한 페이지의 초안을 작성할 때 1시간이 소요됩니다. 만약 30장의 문서를 작성한다면 30시간이 필요한 것입니다. 이를 현실적으로 고려했을 때 문서의 초안 작성이 늦춰지면 다음 단계인 리뷰 (Review) 단계에 할애할 시간이 부족해지고 결국 문서 품질 저하의 결과로 이어집니다. 따라서 정확한 일자에 초안 작성을 완료하는 것이 매우 중요하다고 할 수 있습니다.
4) 리뷰 (Review)
내용, 문서의 구조, 문법, 맞춤법 등 모든 항목을 검토하고 테스트하여 최종본을 제작합니다.
이해관계자 또는 관련 전문가가 있는 경우 작성한 초안에 대한 의견을 수집합니다. 이 과정을 통해 기술적으로 보완되어야 하는 내용이 있는 경우, 다시 문서 작성 (Write) 단계로 돌아가 문서 작업을 진행합니다. 또한 문서 내의 용어/표현의 통일성, 가이드와 용어집 준수 여부와 맞춤법 등을 리뷰하는 과정을 거치는데 이를 피어 리뷰(Peer Review)라고 합니다. ISO 표준에 따르면, 페이지 당 내용 리뷰에 할애되는 시간은 30분이고 단순 교정 작업은 약 15분이 소요됩니다.
리뷰를 진행하고 다시 문서 작성 단계로 돌아가 문서 작업을 하는 과정은 전체 문서 작성 시간의 40% 정도로 가장 많은 시간을 할애하게 됩니다.
5) 배포 (Publish)
완성된 문서를 기획 단계에서 정한 발행일 및 파일 형식에 맞춰 독자들에게 배포합니다.
마지막 문서 배포 단계는 최종 문서를 독자들에게 전달하기 위한 단계입니다. 최근에는 웹 상에 문서를 배포하는 추세로 누구나 쉽게 URL을 통해 문서 접근이 가능하다는 장점이 있지만, 특정 고객사에게만 배포되어야 하는 문서 혹은 기밀문서의 경우에는 PDF 포맷을 사용하거나 권한 관리 등을 통해 특정 사용자에게만 권한을 부여하는 작업을 하기도 합니다.
문서 배포 시에는 각 문서별로 버전을 명시해 이후 문서 관리 목록에서 누락되지 않도록 관리하고 배포 이후 서비스의 기능 등 변경 사항을 정기적으로 반영하는 업데이트 과정도 필요합니다.
테크니컬 라이팅은 무엇인지, 일반 글쓰기와는 어떤 차이가 있는지 그리고 글을 쓸 때 필수로 알아야 하는 것과 글을 쓰는 5가지 단계에 대해 알아보았습니다. 사실 테크니컬 라이팅의 5단계의 경우 이상적인 프로세스이고, 실제로 문서 작업을 진행할 때는 이 프로세스가 제대로 지켜지지 않는 경우가 많습니다. 초안 없이 바로 글을 작성하거나, 리라이팅이 끝난 뒤에 다시 초안부터 작성하거나, 국문 버전으로만 작성하기로 기획 단계에서 정의했는데 다양한 요소로 인해 다국어로 문서를 제작하게 되는 등 크고 작은 문제들이 발생합니다.
하지만 오늘 포스팅에서 소개한 내용들을 알고 글을 쓰는 것과 모르고 글을 무작성 써 내려가는 것은 분명히 큰 차이가 있습니다. 일반 글쓰기와 같이 테크니컬 라이팅 역시 많은 노력과 인내가 필요한 작업이며 실제 ISO/IEC 표준에서 명시한 작업 시간을 통해 그 노력을 간접적으로 알 수 있습니다. 따라서 문서 한 페이지, 하나의 문서를 제대로 작성하기 위해 엄청난 노력과 시간이 필요하다는 것을 문서 이해 관계자 전원이 인지하고 테크니컬 라이팅 프로세스의 존재를 최대한 준수하고자 노력할 때 문서화 작업은 더욱 효율적이며 품질은 향상될 것입니다.
참고
ISO/IEC 15910-2002 - 문서 작성 소요 시간
undernamu - 초보자를 위한 테크니컬 라이팅의 모든 것
Kakaoenterprise - [TW] Technical Writer에서 Technical Communicator로...
