테크니컬 라이팅(technical writing)
‘기술 문서를 어떻게 하면 더 잘 작성할 수 있을까?’라는 생각을 가지고 여러 내용을 참고하여 작성하게 되었습니다.
테크니컬 라이팅
정의
테크니컬 라이팅(technical writing)이란 좁은 의미로는 과학 기술 정보를 정확하고 효과적으로 전달하기 위한 문서 작성 기술을 뜻하고, 넓은 의미로는 단순히 과학 기술 정보를 정확하게 전달하는 글쓰기 뿐만 아니라 모든 유형의 글을 보다 분명하고 알기 쉽게 전달하는 글쓰기를 통칭한다.
테크니컬 라이터?
‘테크니컬 라이터’라는 직업도 있다. 테크니컬 라이터는 IT나 기술 분야에서 쓰이는 어려운 전문 용어들을 독자들이 분명하고 알기 쉽게 풀어 쓰는 직업으로, 앱 시장의 성장에 따라 국내 소프트웨어 기업을 중심으로 테크니컬 라이터에 대한 수요가 증가하고 있는 추세라고 한다. 주업무로는 특정 소프트웨어 상품에 대한 매뉴얼을 작성하고, 새로운 상품이 개발되면 문서를 작성하고 이를 관리하는 역할을 한다. 기술 지식과 문서 편집, 언어에 대한 능력도 필요한 직업이다.
미국 노동 통계국(Bureau of Labor Statistics)에 따르면 테크니컬 라이터의 고용은 2020년부터 2030년까지 12% 증가할 것으로 보이며 이는 모든 직종의 평균보다 빠르게 증가할 것으로 예상하고 있다고 한다.
테크니컬 라이팅 VS 일반 글쓰기
일반 글쓰기와 달리 테크니컬 라이팅은 유용하고 정확한 정보를 독자에게 알기 쉽게 전달하는 것을 최우선의 목표로 한다. 테크니컬 라이팅의 예로 프레젠테이션, 보고서, 설명서, 이력서, 기사, 회사 소개 등 비즈니스 문서 뿐만 아니라 앱·웹사이트와 기술문서의 전문가 그룹 분석·진단 및 리뉴얼, 번역문 리뷰, 직무 및 비즈니스 글쓰기 교육 등 테크니컬 라이팅에 기반한 콘텐츠 컨설팅까지 종류가 다양하다.
테크니컬 라이팅은 소설, 에세이 등과 달리 비즈니스와 관련된 문서 작성 기술이기 때문에 모호한 설명을 지양하고, 독자가 쉽게 이해할 수 있도록 명확하게 기술해야 한다. 또한 주관적인 생각이나 추측이 아닌 타당한 정보를 기반으로 한 사실만을 전달해야 한다.
글쓰기에 앞서 고려해야 할 점
본격적인 내용 작성 전에 해당 문서의 독자의 성격을 파악하는 것이 중요하다. 독자의 배경지식에 따라 용어 및 내용의 난이도를 조절해야 하며, 독자가 글을 목적 또한 고려하여 내용을 작성하는 것이 중요하다. 또한 독자의 문화와 모국어 등에 적합한 관용구와 표현을 사용해야 이해도를 높일 수 있다.
독자를 파악하기 위해 고려해야 할 사항은 다음과 같다.
- 독자는 누구인가?
- 독자의 목표는 무엇이며, 이 문서를 읽는 이유는 무엇인가?
- 독자는 문서를 읽기 전에 이미 무엇을 알고 있는가?
- 독자는 문서를 읽은 후 무엇을 알거나 할 수 있어야 하는가?
테크니컬 라이팅 4대 원칙
1. 명확성 (Clarity)
- 명확한 글이란 핵심어나 핵심 문장이 모호하게 사용되지 않음
- 대상 독자가 기술문서를 읽을 때 내용의 모호함이나 혼란 없이 한 번에 이해하도록 작성해야 함
- 문서를 읽을 때 독자 입장에서 이해가 가지 않아 특정 부분을 몇 번이고 다시 읽게 된다면, 이는 명확성이 떨어지는 글
2. 간결성 (Conciseness)
- 특정 독자가 기술적인 내용을 신속하고 정확하게 이해할 수 있도록 함
- 미사여구나 감탄사 등을 사용하지 않고, 간단하고 쉬운 단어와 간결한 문장을 사용하는 것
- ‘~은 ~입니다.’라는 형식의 단문을 사용할 때 더욱 명확하고, 가독성이 높은 글을 작성할 수 있음
3. 정확성 (Accuracy)
- 독자가 필요로 하는 정보를 기술적 오류 없이 정확하게 제공하는 것
- 명확성과 간결성이 떨어지지만 정확성이 확보된 기술문서라면, 독자들은 시간이 많이 걸린다해도 결국에는 해당 문서를 이해할 수 있음
- 하지만 잘못된 정보가 포함된 기술문서라면 독자에게 무한대의 시간이 주어진다고 해도 해당 문서의 내용을 절대 파악할 수 없게 됨
4. 일관성 (Coherence)
- 문서에 용어, 표현, 어조 등을 일관성 있게 사용하는 것
- 독자 입장에서 조금이라도 오해할 만한 여지를 남기면 안되기 때문에 문서의 일관성 유지는 필수
- 한번 언급된 단어를 다른 방식으로 언급하는 것은 독자에게 큰 혼란을 줄 수 있고, 결과적으로 문서의 신뢰도와 가독성이 저하됨
테크니컬 라이팅 프로세스
주제 선정과 독자 파악이 끝난 이후에는 테크니컬 라이팅의 프로세스에 대한 이해가 필요하다. 테크니컬 라이팅의 프로세스는 기획, 구조화, 작성, 검토, 배포 5단계로 분류할 수 있다.
1. 기획
- 문서의 주제, 발행 일정 및 채널 등을 결정
- 작성하고자 하는 문서에 적합한 템플릿 및 스타일을 확인
- 주제와 관련된 정보 수집, 진행 상황 추적
- 기획이 끝난 후 문서 작성 타임라인과 얻게 될 결과물에 대한 가이드라인을 갖추게 됨
2. 구조화
- 전달하고자 하는 내용을 한 눈에 볼 수 있도록 목차 생성
3. 작성
- 목차를 바탕으로 관련 정보 정리 후 본격적으로 문서 작성
- 내용 작성 시에 리서치를 통해 추가적인 정보를 얻음
- 모호하거나 질문 사항이 있는 경우는 별도로 기록 후 사실 여부 확인
4. 검토
- 이해관계자 혹은 관련 전문가가 있는 경우 작성한 초안에 대해 의견을 수집
- 미비한 부분을 보완하고 사실 여부에 맞게 수정
- 내용 수정이 끝난 후에는 맞춤법과 오타 등 부수적인 사항을 재확인하여 최종본으로 만듦
5. 배포
- 완성된 최종본을 기획 단계에서 정한 발행일에 맞춰 배포
- 시의성이 있는 문서라면 배포한 후에도 내용을 수정하는 등의 지속적인 관리 필요
마치며
단기적인 목표로는 SW마에스트로 과정에서 보다 잘 프로젝트를 수행하기 위해, 장기적인 목표로는 더 나은 개발자가 되기 위해 이번 달 초에 블로그를 새로 열었다. 현재는 내가 ‘지식을 전파한다’보다는 학습한 내용을 올리는 성격의 블로그에 가깝지만 더 나은 개발자가 되기 위해서는 알아야 하는 내용이라고 생각해서 관련 내용을 찾아보고 작성하게 되었다.
현재도 VBA나 Excel 관련 내용으로는 기술 문서를 작성하는데 무리가 없겠지만 백엔드 개발자에게 도움이 되는 기술 문서를 작성하기에는 한참 모자르지 않나 싶다. 이번 기회를 통해 개발 실력과 테크니컬 라이팅 실력을 향상시켜 특정 주기마다 기술 문서를 작성하는 습관을 들여보도록 해야겠다.
