본문 바로가기
취미생활/글또 9기

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

by pilgyeong 2023. 12. 24.

출처 : 유데미 수료증

[강의링크. 기술 블로그로 알아보는 테크니컬 라이팅]


전체 리뷰

본 콘텐츠는 기본적으로 기술 블로그에 초점이 맞춰져 있긴 합니다만, 일반적인 문서(기획안, 사업추진안 등)를 작성할 때도 통용되는 라이팅 방법을 소개해주고 있습니다. 기술 블로그를 운영하는 개발자 뿐만 아니라 각자의 콘텐츠를 블로그나 글로 쓰고자 하는 모든 사람에게도 추천할 수 있는 강의였습니다.

누군가에게는 본 콘텐츠가 당연한 얘기만 한다고 생각하겠지만, 제 생각에는 그렇게 생각하는 사람들도 한 번쯤 되짚어 보기에 좋은 내용이었습니다. 특히, 기술 블로그를 운영하는 개발자라면 꼭 한 번 들어보길 강력추천 합니다.

지금까지 만나왔던 개발자분들의 역량은 매우 뛰어났지만, 그 역량에 비해 상대적으로 글쓰기나 생각을 정리해서 표현하는 부분이 부족한 분들이 많았습니다. 자신은 논리적으로 잘 정리해서 이해하고 있다고 하지만, 그것을 외부에게 표현하는 건 다른 일이거든요. 상대방을 고려해서 글이나 말로 표현하는 능력이 필요합니다. (혼자 이해하는 거랑 전혀 다른 차원의 얘기란 말입니다)

저 역시 컨설턴트이다 보니 문서 작업이 굉장히 많고, 3년 간 수많은 글을 써왔습니다. 그럼에도 제 글쓰기 능력을 한층 더 단단하게 만들어 줄 수 있는 유익한 강의였습니다.

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

 


 

1단계. 작성 계획

글쓰기 과정 3단계 : ①작성 계획 → ②초안 작성 → ③고치기

작성계획 단계에서 핵심은 '독자 선정', '주제 선정', '소재 찾기' 세 가지입니다.

(독자 선정) 읽는 이를 정확하게 정의해야 됩니다. 단순히 개발자라고 정의하는 게 아니라 개발직 취업준비생부터 주니어 개발자까지 또는 5년차 이상 개발자 등 조금 더 디테일하게 정의해야 됩니다. 정의된 독자에게 맞춰 기술 또는 내용 설명의 깊이를 조절해야 되기 때문입니다.

경험.
올해 수행하던 프로젝트에서 데이터베이스 표준화와 모델링 관련 내용을 OO부 차관 보고자료로 만들어야 했습니다. 당연히 차관은 데이터베이스 지식 등 기술과 거리가 있는 분이었기 때문에 보고서의 내용을 굉장히 쉽게 써야만 했습니다. 조금이라도 어렵다고 느낄 만한 기술용어를 해당 페이지 주석이나 바로 아래 단락에 참고 박스로 만들어서 용어 풀이를 했습니다. 특히, 해당 용어가 등장한 페이지에서 바로 알 수 있게 정리했습니다.

(주제 선정) 작성자와 독자 모두 관심이 있는 내용을 주제로 선정해야 합니다. 작성자가 관심 없으면 기술이나 내용의 깊이가 부족할 것이고, 독자가 관심 없으면 읽지 않기 때문입니다. 그리고, 충분한 자료를 찾을 수 있어야 합니다. 따라서, 작성자가 잘 아는 주제를 선정하는 게 좋습니다. 추가로, 글의 완성도를 높이기 위해 주제를 좁히는 것도 하나의 방법입니다. 글의 목차나 논리적 구조를 결정하거나 내용의 깊이를 조절하는 게 영향을 미치기 때문입니다.

경험.
제 글또 9기 첫 번째 글의 주제는 PDCA입니다. 컨설턴트로 일하면서 자주 사용하는 프레임워크이기 때문입니다. 그리고, 글의 완성도를 고려해서 많은 컨설팅 프레임워크 중에 PDCA 하나를 정하며 주제를 좁혔습니다. 만약 제가 '컨설팅 프레임워크'를 주제로 잡았다면, 수 많은 프레임워크를 소개하느라 에너지를 다 소모했을 것이며, 읽는 이도 전공서를 읽는 느낌이 들어 흥미가 떨어졌을 것입니다.

(소재 찾기) 강의에서는 "자료가 반이다"라고 표현할 정도로 중요합니다. 본 콘텐츠에서는 자료를 찾을 때 필요한 자료를 반드시 찾고야 말겠다는 다짐을 유지하며 각성한 상태로 찾아야 한다고 말할 정도로 중요성을 강조했습니다. 자료를 찾는 방법은 검색도 있지만, 평소 쌓아둔 메모도 있습니다. 그리고 찾으면서 날짜와 출처는 꼭 적어두시길 바랍니다. 나중에 한 번에 찾으려면 시간이 매우 많이 소요되거든요.

 


 

2단계. 초안 작성

글쓰기 과정 3단계 : ①작성 계획 ②초안 작성 → ③고치기

일단, 쓴다.

"일단, 쓴다."는 여기서 모든 것을 관통하는 말이라고 생각합니다.

생각.
개인적으로 "일단, 쓴다."는 글쓰기 뿐만 아니라 삶의 전반적인 영역에서 의미를 갖는다고 생각합니다. 사람이기 때문에 모든 것을 미리 계획하고 시작할 수 없기 때문입니다. 제 MBTI가 J(95%) 정도로 강한(?) 계획형이지만, 모든 걸 계획하는 게 아닌 구조만 계획하고 일단 시작합니다. 그것이 사업이든, 공부든, 늘 그래왔던 것 같습니다.🤔

본 콘텐츠에서는 처음부터 목차를 잡고 쓰든, 중간 또는 마지막 부분부터 쓰든, 일단 써야한다고 강조합니다. 그리고, "키워드 → 문장 → 단락 → 챕터 → 문서" 순서로, 맨 처음에는 글의 키워드를 정하는 것이 편하다는 팁을 주셨습니다. 참고로, 글의 분량은 A4 용지로 7~10장 정도가 되면 정보를 전달하기 충분한 분량이라고 합니다.

여기에서 Clear(명확) + Concise(간결) + Consistent(일관)으로 구성된 3C 법칙이 등장합니다. 위의 강의 링크로 들어가면 알 수 있다시피 부제목에 3C 법칙이 나올 정도로 강조합니다.

Clear: 모호함 없이 정확한 내용으로 선명한 문장을 써야 합니다. 이를 위해 ①내용은 정확하고, ②수식어를 줄이되 객관적인 데이터를 사용하며, ③분명한 글꼬리를 사용하여, ④대명사는 되도록 쓰지 않아야 합니다. 특히, '링크'를 걸어줄 때 대명사를 사용하지 않도록 주의해야 합니다. 단순히 [여기]이 아닌 [ㅇㅇㅇ목록]과 같이 링크 이름을 쓰는 게 좋습니다.

Concise: 간단하며 짧게 쉬운 문장을 써야 합니다. ①단문으로 쓰고, ②쉬운 표현으로 문장을 작성합니다. 읽는 이를 정확하게 정의하는 것은 여기에서 중요합니다. 쓰는 용어나 표현의 정도가 달라지기 때문입니다. 간결함을 위해서라도 읽는 이는 정확하게 정의하는 것이 중요합니다.

Consistent: 일관된 내용, 일관된 형식, 일관된 표현으로 문장을 써야 합니다. ①문서 주제의 일관성, ②형식의 일관성, ③용어나 표현의 일관성 세 가지를 주의하면, 일관된 글을 쓸 수 있습니다.

 


 

3단계. 고치기

글쓰기 과정 3단계 : ①작성 계획 → ②초안 작성 → ③고치기

본 콘텐츠에서 나쁜 글쓰기 습관으로 다음의 내용을 소개했습니다.

  • 초안 작성 후 다 썼다고 생각하는 것
  • 고치기 단계에서 맞춤법과 띄어쓰기에만 집중하는 것
  • 쓰자마자 바로 검토하는 것
  • 공개하기 부끄러워서 혼자서만 보고 또 보는 것

본 콘텐츠에서 "글쓰기의 본질은 고치기이다"라고 말할 정도로 많은 시간과 노력이 필요한 부분입니다. 글을 고칠 때는 글의 배치를 고려해야 되는 데, 역피라미드 구조로 쓰는 게 좋습니다. "핵심 내용 요약/소개 → 배경/근거 등 구체적인 설명 → 일반적인 내용 및 참고 사항" 순서로 배치하는 게 좋습니다.

고치기 내용이 많지만 핵심 몇 가지 소개하면, ①주어+술어를 맞추는 것이 가장 중요하며, ②목적어는 생략하지 않고 불필요한 말이나 조사는 생략하고, ③시각적 자료(그래프, 표 등)을 활용하면 좋습니다.

그리고, 글을 검토하는 과정의 팁도 소개드립니다. 하루 지난 후 읽거나 소리 내어 읽기 또는 인쇄해서 읽기 등 객관적인 태도를 유지할 수 있는 장치를 통하면 좋습니다. 또는 동료의 검토를 받을 때 더욱 객관적일 수 있겠지요.

 


 

마치며

본 강의를 수강하며, 중요하다고 생각하는 내용만 간략히 작성했습니다. 자세한 내용은 강의를 참고하시는 게 좋을 것 같습니다. 강의시간도 약 2시간으로 짧기 때문에 부담없이 수강할 수 있는 점도 좋습니다. 특히, 기술 블로그를 운영하는 개발자분들에게 많은 도움이 될 것입니다. 물론, 문서 작성이 많은 직업을 가진 분들도 좋을 것이구요.


해당 콘텐츠는 유데미로부터 강의 쿠폰을 제공받아 작성되었습니다.