[Udemy(유데미) 강의 후기] 기술블로그로 알아보는 테크니컬 라이팅

h-go-getter·2024년 1월 21일

👀 1. 들어가며

1.1. 상황

글또('글쓰는 또라이가 세상을 바꾼다' 글쓰는 개발자 모임)에서 유데미의 강의 쿠폰을 제공받아 강의를 들을 수 있는 기회가 생겼습니다. 많은 강의 중에 최대 2개를 선택할 수 있었는데, 그 중 하나로 '테크니컬 라이팅'강의를 선택했습니다.

'기술블로그로 알아보는 테크니컬 라이팅' (강의 소개 페이지)은 현 우아한형제들, 전 NHN과 네이버에서 테크니컬 라이터 이력을 가지신 유영경 코치님의 강의였는데요. 작년부터 기술블로그를 써오면서, 기술적인 주제를 더 명확하게 전달하고 쉽게 이해할 수 있도록 쓰고 싶다는 생각이 들어 선택했습니다🤗

1.2. 예상독자

이 글에서는 강의 구성 소개와 강의 중 인상깊었던 내용을 적용해 제가 쓴 기술 글을 개선해 본 내용을 담았습니다. 이런 분들이 읽으시면 도움이 될 것 같아요

'기술블로그로 알아보는 테크니컬 라이팅'을 듣기 전 후기가 궁금하신 분
기술블로그를 운영하면서, 테크니컬라이팅을 배워보고 싶은데 어떻게 배울 수 있을지 강의를 찾아보고 계신 분

✍️ 2. 기술블로그로 알아보는 테크니컬 라이팅

2.1. 강의 소개

'기술블로그로 알아보는 테크니컬 라이팅'은 개요 포함 6개의 섹션, 24개의 강의로 구성돼있습니다. 총 길이는 2시간 4분이고, 가격은 39,000원입니다. (유데미를 처음 수강한다면 쿠폰 적용이 가능한지 확인해 보시길 바랍니다. 쿠폰 적용시 1만원 대에도 수강 가능한 것 같아요!)

테크니컬 라이팅 개념과 특징부터, 문서 작성 프로세스 별로 어떻게 작성할 수 있을지 사례와 함께 소개해 주시고 있어서 유용하게 들었습니다.

2.2. 인상 깊은 내용

강의 내용 중 인상 깊었던 부분이 많았는데요. 그 중 실제 적용해 본 2가지를 소개합니다.

① '2장. 독자를 선정하고 주제를 잡는 방법'의 🎯독자와 주제 선정

② '3장. 초안 작성하기'의 🌟명확하게 쓰기

① 🎯독자와 주제 선정

[독자 선정]

코치님은 독자를 구체적으로 선정해야한다고 소개합니다. 무엇을 독자가 알고 있느냐에 따라 설명 방식이 달라져야 하기 때문에, 읽는 이가 누구인지 확실하게 정해야 한다고 강조합니다. 독자에 따라 설명할 기술의 깊이가 달라지기 때문이죠.
✅ 저의 목차에도 '예상 독자'가 포함되어있는데요. OOO에 관심있는 분들, OOO을 스터디해보고 싶은 분들 같이 구체적이지 못했던 것 같아 개선해봐야겠다 느꼈어요.

[주제 선정]

주제 선정에서는 어떤 주제를 써야할지 고민하는 사람들에게 필요한 조언들을 해주십니다. 많은 조언들 중에 주제를 최대한 좁혀서 시작하는 게 중요하다는 부분이 가장 도움이 됐어요.
예를들어 'git hub 사용법'이라는 주제는 많은 내용이 담길 수 있는 광범위한 주제입니다. 글을 쓰는 사람도 큰 부담이 되고 읽는 사람도 본인이 원하는 내용이 담겨있을지 구체적으로 파악하기 어렵습니다. 만약 글 주제가 'git hub를 사용한 효율적인 문서 검토 방법'이면 어떨까요? 글을 쓰는 사람도 구체적인 경험을 담을 수 있고, 독자도 실용적인 경험을 글을 읽고 가져갈 수 있습니다.
✅ 저도 광범위하게 주제를 선정한 글은 시작하기 전에 지쳐 다른 주제로 바꿔서 업로드 한 경험이 많아서, 올해는 글 주제를 정할 때부터 좀 더 구체적이고 최대한 좁혀서 시작해야겠다 느꼈어요!🎯

② 🌟명확하게 쓰기

'3장. 초안 작성하기'에는 명확하고 간결하고 일관성있게 쓰는 것이 중요하다고 소개합니다. 이중에서 '명확하게 쓴다'가 가장 인상깊었는데요. 코치님이 예시로 소개해주신 명확하지 못한 글과 제가 쓴 글의 공통점들을 많이 발견했기 때문입니다🤣

그 중 2가지 공통점을 소개합니다.

ⓐ 📊 어느 정도인지 객관적으로 제시하는게 중요
ⓑ 🔗링크 이름을 대명사로 쓰지 않기

[ⓐ📊어느 정도인지 객관적으로 제시하는게 중요]
수식어보다 명확하고 객관적인 데이터를 사용하는 것이 중요하다고 강조하셨어요.

예를들어 "불과 얼마 전까지만 해도 데이터 센터에 관심이 없었다."라는 문장이 있으면, 여기서 '불과 얼마 전까지만 해도' 부분은 명확하지 않습니다. 구체적인 일자가 빠져서 명확하지 않은게 아니라 왜 관심이 없었는지 설명하고 있지 않기 때문입니다. 이 문장은 "OOOO인증을 받기 전까지 데이터 센터에 관심이 없었다."로 수정할 수 있습니다.
✅ 매우, 아주, 꽤, 상당히, 괄목할 만하게, 대단히 등 애매한 수치를 말하는 수식어를 글에 습관적으로 사용하고 있는 것 같아 의식하고 작성해야겠다 느꼈어요

[ⓑ🔗링크 이름을 대명사로 쓰지 않기]

링크 이름을 대명사로 쓰지말고 구체적으로 작성하라고 강조하셨어요.
예를들어서 "오류 코드를 확인하면 여기를 참고하세요."대신에 "오류 코드를 확인하려면 오류 코드 목록을 참고하세요."라고 수정하는 것이죠.
✅ 글에서 링크 참조를 할 때, 대명사를 주로 걸고 있어서 수정해야겠다 생각했어요. 제가 독자여도 "링크"나 "여기"라는 대명사에 참조된 링크는 어떤 링크가 있는지 정보가 없어서, 클릭하기 경계될 것 같아요.