[강의] 유데미 기술블로그로 알아보는 테크니컬 라이팅 수강 후기
"기술"이라는 특정한 주제로 글을 작성하는 데 어려움을 느꼈다면 추천드리고 싶은 강의가 있습니다. 바로 유데미의 기술블로그로 알아보는 테크니컬 라이팅 강의입니다.
총 강의 시간도 약 2시간으로 부담 없이 들어볼 수 있고, 저도 바로 그런 점에서 끌려 수강을 시작하였습니다. 결과는 대만족. 시간을 들여서 완강할만한 강의라는 판단이 들었습니다. 오늘 포스팅에서는 강의를 들으며 습득한 정보를 조금이나마 풀어보겠습니다. 더 많은 정보를 자세하게 얻고 싶다면 역시 강의를 직접 듣는 것이 가장 좋은 선택이겠죠?
테크니컬 라이팅이란 기술 글쓰기로, 풀어 쓰자면 특정 독자를 대상으로 특정 목적을 갖고 특정 정보를 전달하는 글쓰기입니다. 여기서 "특정"이라는 단어가 많이 나왔는데요. 그만큼 일반 문학과 테크니컬 라이팅에서는 본질적으로 다른 글쓰기 방법을 사용하는 것 같습니다. 문학 글쓰기와 테크니컬 라이팅의 차이는 다음 표와 같습니다.
| 분류 | 문학 글쓰기 | 테크니컬 라이팅 |
| 내용 | 창의 | 사실 |
| 대상 | 일반 | 특정인 |
| 표현 | 상징 | 직설 |
| 구성 | 자유 | 순차 |
그럼 글을 써야하는 이유는 무엇일까요? 말로 표현을 하면 안 되는 걸까요? 글을 써야 하는 이유는 바로 다음과 같습니다.
- 효과적인 의사소통
- 정보 기록과 보존
- 경쟁력 강화
정확하게 생각을 전달해 오해 없이 소통하고 업무 효율을 늘릴 수 있고(효과적인 의사소통), 기억력의 한계를 보완하고 다른 사람에게 쉽게 전달이 가능하며(정보 기록과 보존), 경험과 지식을 공유해 경쟁력을 강화(경쟁력 강화)할 수 있습니다. 이런 많은 장점이 있으니 꾸준하게 써보는 것이 아무래도 이득일 것 같습니다.
기술 문서 작성 프로세스는 다음과 같습니다.
- 계획 세우기
- 초안 작성
- 고치기
위 세가지 중에서 어떤 단계에 가장 많은 시간을 할애해야 할지 짐작이 가시나요? 바로 "고치기" 단계입니다. 강의에서는 총시간의 약 4-50% 정도를 고치기 단계에 할애해야 한다고 말하고 있습니다. 그럼 각 단계에서는 어떤 작업을 해야 하는지 조금 더 자세히 알아보도록 하겠습니다.
독자를 선정하고 주제를 잡는 방법
우선 가장 먼저 해야 할 것은 독자를 선정하는 일입니다. 어떤 수준의 독자인지에 따라 글에서 사용할 수 있는 어휘나 단어들이 달라질 수 있으니까요. 모든 사람을 대상으로 작성한 글과 단지 개발자만을 대상으로 작성한 글에는 같은 내용일지라도 분명한 차이점이 있습니다. 구체적으로 대상 독자를 정하고 글을 쓰고, 독자에 대해 전문용어를 사용하고 풀이를 제공해야 합니다.
다음은 가장 중요한 일 중 하나인 주제 잡기입니다. 주제는 글감이라고도 합니다. 작성자와 독자 모두가 관심이 있는 주제를 잡아야 하고, 또한 그 주제에 대해 자료를 충분히 찾을 수 있어야 합니다.
저는 개인적으로 이 단계가 가장 어렵다고 생각이 드는데요. 정말 다양한 주제를 생각해 놓고 있더라도, 막상 쓰기 시작하면 어떤 주제를 잡아야 할지 머릿속이 까맣게 변하는 느낌입니다. 이걸 예방하기 위해 평소에 글감이 생각나면 메모를 꼭 하고 있습니다.
마지막으로 소재를 모아야 합니다. 필요한 자료를 꼭 찾고야 말겠다는 마음가짐으로 며칠 굶은 하이에나 처럼 자료를 샅샅이 찾아야 합니다. 여기서 중요한 것은 쓸데없이 너무 많아도 안되거니와 너무 적게 찾아서도 안됩니다. 필요한 자료만 계획해서 찾아내는 것이 중요합니다.
초안 작성하기
이제 드디어 글을 써볼 차례입니다. 처음부터 완벽히 쓰려 하지 말고 일단 쓰는 것이 중요합니다. 어디서부터든 일단 쓰면 실패할 확률이 적어집니다. 맨 처음에는 글의 키워드만 적어 봅시다. 이 포스팅의 경우에는 "테크니컬 라이팅", "강의", "수강 후기" 정도가 될 것 같습니다.
글을 쓸 때 유의할 원칙도 세가지가 있는데, 다음과 같습니다.
- Clear: 명확
- Concise: 간결
- Consistent: 일관
무엇보다 내용이 정확해야 합니다. "~하는 것 같습니다." "~않지 않습니다." 같은 말을 자제하고 분명한 글꼬리를 사용해야 합니다. 저도 많이 쓰는데 반성하고 자제해야겠습니다.
그리고 또 좋은 팁이 있는데, 링크 이름을 대명사로 쓰지 말아야 합니다. 예를 들어서 "여기 이 부분을 봐주세요." 보다는 "테크니컬 라이팅 수강 후기를 봐주세요."가 더 명확합니다.
꼭 어려운 표현을 사용할 필요는 없습니다. 물론 사용하면 글이 더 멋있어 보이는 효과가 있을지는 몰라도, 진입 장벽에 독자들이 도망칠 가능성이 있습니다. 웬만하면 쉬운 표현을 사용하도록 합니다.
문서 주제나 형식에 일관성을 유지합니다. 용어도 마찬가지입니다. 앞 문단에서는 "테크니컬 라이팅"이라고 쓰고, 뒷 문단에서는 "기술 글쓰기"라고 쓰는 것이 잘못된 예입니다.
문서 고치기
이제 초안을 완성했으니 검토할 시간이 왔습니다. 검토를 할 때는 시간 간격을 두는 것이 좋습니다. 월요일에 초안을 작성했다면 화요일, 수요일 등 하루 이틀정도의 시간을 두고 검토해야 객관적으로 바라볼 수 있습니다.
아니면 예비 독자에게 피드백을 요청해보는 것도 좋은 방법입니다. 그러나 저같이 친구가 극소수라면 사용할 수 없는 그림의 떡 같은 방법이니 가슴 아프지만 첫 번째 방법을 사용해 봅시다.
만약 글에서 전문용어나 약어를 사용한다면 뜻을 추가합니다. 물론 대상 독자 대부분이 쉽게 알 수 있는 용어라면 풀이를 쓰지 않습니다. PC(Personal Computer)라고 쓰지 않아도 된다는 말입니다.
단락이 너무 길면 글이 지루하게 보이니 단락 하나에 중심 생각 하나만 담습니다. 아이디어나 주제에 따라 단락을 나눕니다.
시각 자료나 표를 활용하는 것도 좋은 방법입니다. 시각 자료를 사용한다면, 뒤가 아니라 앞 문장에 자료에 대한 설명을 넣습니다. 표는 제한된 공간에 방대한 양의 데이터를 제시할 때 쓸모가 있습니다.
중요하지만 놓치기 쉬운 맞춤법 검사도 해야되겠죠. 스스로 검사할 수 있다면 좋겠지만 안타깝게도 그 맣은 양의 맞춤법이 머리에 있을리가 만무하니 맞춤법 검사기를 사용해 봅시다.
오늘은 강의 수강 후기를 작성해 보았는데요. 강의를 듣고 얻은 지식을 오늘 포스팅에 적용해 보았는데 어떤가요? 조금 더 글이 좋아졌을까요? 아니라면 더 노력을 해 보아야겠습니다.
하지만 글을 잘 쓰는 가장 좋은 방법은 역시 꾸준히 쓰는 겁니다. 어렵다고 쓰는 것을 차일피일 미루거나, 퀄리티가 낮다고 공개하는 것을 꺼리면 안 됩니다. 꾸준히 쓰다 보면 자연히 처음보다는 더 좋은 글이 써지게 되어있습니다. 오늘부터 한 번 써보는 것이 어떨까요?
해당 콘텐츠는 유데미로부터 강의 쿠폰을 제공받아 작성되었습니다.