서론
기술 블로그를 운영하며 약 2년 동안, 저는 주로 글의 주제와 대상 독자에 초점을 맞추어 왔습니다. 글쓰기 방법에 대해 깊이 고민해본 적이 없었지만, '글또' 활동을 시작하며 글쓰기에 대한 관심이 자연스럽게 생겼습니다. 이러한 관심을 바탕으로, 저는 테크니컬 라이팅이라는 분야를 알게 되었고 관련 강의를 수강하게 되었습니다. 이번 글에서는 수강한 강의를 통해 배운점을 간단히 요약하고 느낀 점을 써보고자 합니다.
개요
- 테크니컬 라이팅 개념과 특징
- 작성 계획
- 초안 작성
명확, 간결, 일관 - 고치기
문서 구조 확인
가독성 높이기 - 동료 검토
본론
1. 테크니컬 라이팅의 개념과 문서 작성 프로세스
테크니컬 라이팅이란 특정 독자를 대상으로 특정 목적을 갖고 특정 정보를 전달하는 글쓰기입니다. 기술 정보를 명확하고 이해하기 쉽게 전달하는 글쓰기 입니다.
문학글쓰기와 테크니컬 라이팅의 차이는 아래와 같습니다.
| 분류 | 문학 글쓰기 | 테크니컬 라이팅 |
|---|---|---|
| 내용 | 창의 | 사실 |
| 대상 | 일반 | 특정인 |
| 표현 | 상징 | 직설 |
| 구성 | 자유 | 순차 |
기술문서 작성 프로세스는 작성 계획, 초안 작성, 고치기로 총 3단계로 구분됩니다. 작성 계획에서는 소재를 찾고 일정을 계획합니다. 초안 작성에서는 자료를 수집하고 배치합니다.
고치기에서는 글을 검토하고, 글을 수정합니다.
2. 독자를 선정하고 주제를 잡는 방법
독자들의 이해도에 따라 글 유형은 달라지기 때문에 독자층을 잘 정하는 것이 테크니컬 라이팅에서는 중요합니다. 설명할 기술의 깊이를 조절해야 합니다. 구체적으로 대상 독자를 정하고 독자에 맞게 전문용어를 사용하고 풀이를 제공해주어야합니다.
주제는 글감이라고도 하며, 내용, 메시지, 테마 등이 함께 뒤섞인 말 입니다. 쓰고자 하면 모든 것이 쓸거리이기 때문에 쓸 주제가 없는 것이 아니라 주제를 정하지 못한 것 뿐입니다.
하지만 주제를 정할 때는 주의가 필요합니다. 작성자와 독자 모두 관심이 있는 주제를 정하는 것이 중요합니다. 생소한 주제를 적을 경우 자료를 찾기 어려움이 있으므로 자료가 충분히 있는 주제를 정하는 것이 좋습니다. 일정 내에 쓸 수 있는, 너무 방대하지 않은 주제를 정하는 것이 좋습니다.
이렇게 주제를 정하였다면 한편의 글을 일정 내 좋은 품질로 완성하려면 주제를 좁히는 것이 중요합니다. 또한 저자가 잘 아는 주제를 정해서 나의 이야기와 직접 경험한 내용을 녹여낸다면 더욱 좋은 글을 작성할 수 있습니다. 결과적으로 단순히 내용 전달만 하는 것이 아니라 나만의 이야기를 전달하는 것이 중요합니다.
그렇다면 소재를 모을려면 어떻게 해야할까요? 평소에도 메모하는 습관을 들여서 소재를 꾸준히 모아두는 것이 중요합니다. 이때 자료, 소재를 모아둘 때 날짜, 출처 기입 또한 매우 중요합니다. 그리고 여기저기에 메모해 두지 말고 정해진 한 군데에만 메모해 두는 것이 중요합니다.
자료를 수집할 때는 구체적인 근거와 사례가 필요합니다. 무언가를 주장, 설명하는 글을 쓸 때는 이유, 사례, 데이터를 정확히 표기하는 것이 중요합니다.
3. 초안 작성하기
글 쓰는 방법에 정답은 없습니다. 자신에게 맞는 글쓰기 방법을 사용하는 것이 중요합니다. 처음부터 너무 완벽하게 글을 쓰려고 하지 말고 일단 자신 있는 부분부터 글을 써보는 것도 좋습니다. 맨 처음에는 글의 키워드 부터 정해보는 것이 좋습니다.
테크니컬 라이팅은 3C(Clear, Concise, Consistent)를 기억하는 것이 중요합니다. 명확하게, 간결하게, 일관된게 글을 쓰는 것이 독자에게 정보를 쉽고 정확하게 전달할 수 있습니다.
4. 문서 고치기
검토와 재작성의 중요성
글 작성하는 시간 전체가 100%라면 고치는 데에 40%를 투자하는 것을 권장드립니다. 글을 검토할 때 맞춤법 외에도 전체적으로 다시 재검토가 필요합니다. 문서의 핵심 내용이 먼저 나와있는지 검토하는 것이 중요합니다.
빠진 내용을 찾기에 있어 MECE 기법을 사용하면 좋습니다. 빠지는 요소 없이 전체 중복없이 나열하는 방식으로 분석하는 것을 의미합니다.
목차 제목 수준은 장 제목을 제외하고 제목 3(3 depth)수준 까지가 적절 합니다. 그리고 제목 아래 하위 제목이 1개라면 제목을 없애고 상위 제목을 구체적으로 변경하는 것이 좋습니다.
문장 검토하기
바른 문장을 쓰고 불필요한 단어 삭제를 하는 것이 중요합니다. 자주보는 문장 오류는 주어와 서술어가 호응되지 않음, 목적어 생략, 모호한 표현, 외국어 남용, 구어체, 은어 등 형식적이지 않은 용어나 표현 사용, 번역 투 남용, 피동형 남발, 일관되지 않은 용어나 표현 사용, 오탈자, 띄어쓰기 오류가 있습니다.
문장 구성 요소가 제대로 호흥해야 한다.
클라우드 서비스의 장점은 필요할 때 원하는 만큼만 리소스를 사용할 수 있다.
- 클라우드 서비스의 장점은 필요할 때 원하는 만큼만 리소스를 사용할 수 있다는 점이다.
- 필요할 때 원하는 만큼만 리소스를 사용할 수 있다는 점이 클라우드 서비스의 장점이다.
목적어를 생략하지 않는다.
툴팁을 보려면 물음표 아이콘 위에 살짝 올려주세요.
- 툴팁을 보려면 물음표 아이콘 위에 마우스 포인터를 살짝 올려주세요.
불필요한 말은 덧붙이지 않는다.
발송 중에 취소해도 일부 수신자에게는 발송이 진행될 수 있습니다.
- 발송 중에 취소해도 일부 수신자에게는 발송될 수 있습니다.
불필요한 조사를 덧붙이지 않는다.
앱을 종료하려면 홈 메뉴를 클릭을 하고 종료 버튼을 클릭을 합니다.
- 앱을 종료하려면 홈 메뉴를 클릭하고 종료 버튼을 클릭합니다.
줄이고 줄인다.
계획되지 않은 장애로 인하여 서버가 서비스를 제공하지 못하게 되면, 자동으로 장애 조치를 수행합니다.
- 장애로 인하여 서버가 서비스를 제공하지 못하게 되면, 자동으로 장애 조치를 수행합니다.
~을 위해서, ~으로 인하여 와 같은 문장들은 더 명확한 표현으로 수정이 필요합니다.
이런 번역투 문장을 고칠 경우 문장이 더 명확해져 이해하기 쉽습니다. - 서버에 장애가 발생하면 자동으로 장애 조치를 수행합니다.
외국어보다 우리말을 사용한다.
익월 배포 issue 없게 준비합시다. 새 feature를 추가하는 것보다 performance를 높이는 stance는 유지하고요. 관련 부서에도 wording 다듬어서 quick하게 comm.해주세요.
- 다음 달 배포 문제 없게 준비합시다. 새 기능을 추가하는 것보다 성능을 높이는 입장을 유지하고요. 관련 부서에도 내용 다듬어서 빠르게 협의 해주세요.
이때 적당한 우리말이 없다면 음차해서 쓴다. 예) server -> 서버.
특정 분야 저문 용어라면 원문을 병기한다. 텐서(tensor)는 배열이나 행렬과 매우 유사한 특수한 자료 구조 입니다.
타사 서비스나 제품 이름인 고유명사는 원문 그대로 쓴다. 예) Microsoft Azure, Adobe Acrobat
은어(jargon) 사용에 주의한다.
익셉션 에러, 엑박 등과 같은 용어는 사용을 지양하는 것이 좋다.
전문용어와 약어 풀이
각각 분야에 따라서 용어의 뜻이 다를 수 있습니다. 전문적인 용어는 짧게 설명하는 글을 추가하는 것이 좋습니다. 이때 용어 정의는 용어가 처음 등장하는 부분에 작성하는 것이 좋습니다.
마소, 갤23, AOS 등과 같이 고유명사를 임의로 줄여쓰지 않는 것이 좋습니다.
가독성을 높이는 법
단락 다시쓰기
단락이 너무 길면 글이 지루해 보입니다. 단락을 나누기 적당한 구간은 3~5줄 정도에서 나누는 것이 적당합니다. 그리고 단락 하나에는 중심 생각 하나만 담습니다. 주제가 전환되는 구간에서 단락을 나누는 것도 좋은 방법입니다.
목록을 보여줄 때 점 목록은 순서에 관계없는 동등한 항목을 나열할 때 사용합니다.
숫자 목록은 순서가 있는 동등한 항목을 나열할 때 사용합니다.
시각자료 활용하기
대부분의 사람들은 시각적 자료를 먼저 보고, 인지합니다.
- 사진
사물의 생김새를 보여줄 때 - 그래프
수나 양을 표현할 때 - 관계도
구조, 관게 등의 논리적인 흐름을 나타낼 때 - 표
항목을 비교하거나 정리할 때
스크린샷을 이용할 경우 다음과 같은 항목을 지키는 것이 중요합니다.
- 최신 OS에서 캡쳐 권장
- 전체 화면보다 필요한 부분만 캡처
- 복잡한 UI일 때는 강조 표시 활용
- 설명 텍스트는 이미지 바깥에 배치
설명 문구를 이미지 안에 배치할 경우 번역이 번거로워져 비용이 더 들 수 있습니다.
시각 자료를 배치할 때는 자료의 설명을 먼저 배치한 후 그 다음에 시각자료를 배치해 놓는 것이 좋습니다.
표 사용하기
표는 다음과 같은 상황에서 주로 사용됩니다.
- 표는 제한된 공간에 방대한 양의 데이터를 제시할 때
- 항목별로 상세한 비교가 필요할 때
- 개별 데이터 값을 쉽게 찾도록 할 때
맞춤법과 외래어 표기법 확인하기
글을 작성할 때 맞춤법 검사기를 활용하면 효율적으로 글을 수정할 수 있습니다. 이때 맞춤법 검사기로 검토가 어려운 부분은 직접 검색하거나 사전을 통해 찾아보는 것이 좋습니다. 한글 맞춤법 참고는 다음을 참고하면 좋습니다. 다양한 맞춤법 검사기를 활용해보면서 자신에게 맞는 맞춤법 검사기를 사용하는 것이 좋습니다.
- 네이버 맞춤법 검사기
- 우리말 배움터 한국어 맞춤법/문법 검사기
- 국립국어원
도입부 작성하기
도입부의 역할은 글을 읽을 동기부여, 흥미 유발, 본문 안내 등이 있습니다. 흥미로운 도입부를 작성하는 방법은 다음과 같습니다.
- 질문으로 먼저 시작하기
- 용어나 개념을 미리 설명하기
- 나만의 경험을 서술하기
- 유명한 인물이 썼던 문장을 인용하기
- 최신 화젯거리를 이용하여 글의 첫 문장 쓰기
5. 동료 검토와 문서 배포하기
동료 검토
검토를 본인만 하면 수정사항을 발견하기 어려우므로 동료 검토가 중요합니다. 동료 검토의 목적은 서로의 글을 읽으면서 분석적 읽기를 연습하고 자신의 글을 되돌아보기 위함입니다. 이때 분석적 읽기란 글을 읽어 내려가면서 문서의 내용을 분석해보며, 글의 구조를 파악하고 저자가 생각한 '문서 개요'를 독자 입장에서 찾아보는 것 입니다.
자기 검토
효율적인 자기검토 방법은 다음과 같습니다.
-
객관화
내문 서와도 거리 두기가 필요하므로 시간이 좀 흐른 뒤에 다시 읽어보는 것이 좋습니다. -
다른 감각 활용
눈으로만 읽지말고 소리 내어 읽어보는 것이 좋습니다. -
매체 변경
인쇄를 하거나 스캔을 해서 다시 읽어보는 것이 좋습니다.
최종 점검
- 기밀 정보 확인
- 최신 정보인지 확인
- 시각 자료 확인
- 코드 확인
- 링크 테스트
- 출처가 명확한지 확인
- 문서 스타일이 일관된지 확인
결론
기술블로그로 알아보는 테크니컬 라이팅 강의를 통해 통해 명확하고 간결한 글쓰기와 말하기 기술을 익힐 수 있었습니다. 제 글을 읽은 후 기술블로그를 쓸 때 지켜야 할 규칙들이 너무 많아 보일 수 있습니다. 하지만 복잡하게 생각하지 말고, 자신이 전달하고 싶은 내용을 간단히 메모하는 것에서부터 시작해보세요.
그리고 나서, 차근차근 위 규칙들을 적용해 나가다 보면, 어느새 멋진 글이 완성되어 있을 겁니다. 이 글을 통해 여러분도 테크니컬 라이팅에 대한 호기심을 갖고 멋진 글을 써보셨으면 보시길 바랍니다.
감사합니다.
해당 콘텐츠는 유데미로부터 강의 쿠폰을 제공받아 작성되었습니다.
