[강연노트] 개발자의 글쓰기

이 글은 우아한 테크 세미나 '개발자도 글을 잘 써야 한다고요?'를 본 후 정리한 글입니다.

---

 

뭘 써야 할지 모르겠어요 😞

• 내 삶의 모든 것이 다 글감이 될 수 있다
• 내가 하고 있는 일 중에서 단서를 찾아보면 좋다
  • Ex) 새 환경 적응기, 시스템 개선 후기 등등
• 내가 경험한 나의 얘기를 녹여내면 생생한 글을 쓸 수 있다

 

주제 정하기  📌

• 작성자와 독자 모두 관심이 있는가
• 충분히 자료를 찾을 수 있는가
• 일정 내에 쓸 수 있는 내용인가

 

소재 모으기 📚

• 외부 자료 조사
  • 반드시 찾고야 말겠다는 집요함과 집중력으로 찾자
  • 왜?라는 꼬리에 꼬리를 무는 질문을 하며 자료를 찾는다
• 메모 & 정리
  • 한 곳에 내용, 출처, 검색 날짜를 정리
  • 숫자, 근거, 사례로 정리
  • 소재별로 그루핑 그루핑

 

글감 & 소재 효과적으로 찾는 법 🔎

• 쉽지 않은 일이다
• 평소 관심사를 바탕으로 잘 메모해두고 이를 바탕으로 소재를 찾아내는 것이 중요 (상향식)
  • 이미 메모해둔 것도 있으니 백지상태의 공포는 피할 수 있다
• 메모가 의미 있으려면
  • 쉬운 형식으로 반복 작성 가능해야 함
  • 각 메모 간의 연결성을 파악할 수 있어야 함

 

제텔카스텐 📦

독일 니클라스 루만(Niklas Lumann) 교수가 고안한 메모 방법론

제텔(Zettel): 종이 쪽지, 메모 / 카스텐(Kasten): 상자, 서랍

1. 관심분야에 대한 메모를 다른 사람이 봐도 이해할 수 있을 정도의 수준으로 짧게 한 문장으로 써보기
2. 새로 쓴 메모와 기존 메모가 연결된다면 다 연결해보기
3. 연결된 메모들이 쌓이면 내 관심사와 키워드, 소재를 발굴할 수 있음

• 제텔카스텐 기반 툴 : 옵시디언(무료), 롱리서치(유료), … 노션으로도 제텔카스텐 구축 가능

 

대상 독자 정하기 🧑‍💻

• 대상을 구체적으로 좁혀나갈수록 글의 방향이 명확해진다

---

글쓰기 ✍️

초고 작성 🐣

• 큰 그림은 잡아둔다
• 어디서부터든 가장 자신 있는 부분부터 일단 쓴다
• 일단 쓸 수 있는 것부터 블록처럼 쓴 후 나중에 정리한다
• 시청자 팁 : 생각난 걸 말로 먼저 얘기해서 녹음하면 정리가 되더라

 

퇴고(=수정)하기

• 글쓰기의 본질은 고치기이다.
• 전체 일정 중 퇴고 시간을 넉넉하게 잡아야 한다
• 초고 쓰고 시간이 좀 지난 후에 검토한다
• 띄어쓰기 맞춤법보다는 전체 흐름을 본다
• 다른 사람에게도 보여주고 리뷰받는다
• 자신의 글의 객관화를 위해서는 시간이 필요하다.
• 다른 사람이 썼다는 마음으로 내 글을 보자. 하자를 찾겠다는 마음으로 본다

---

QnA

공개하기 부끄럽다. 어떤 글을 공개하면 좋을까?

• 부끄러움도 감수할 수 있는 편한 사람에게 먼저 공개해보자. 동료 검수.
• 내 동료가 검수를 요청한다면 장단점을 같이 얘기해주자

 

글쓰기 습관 들이는 방법?

• 습관처럼 글을 쓸 수 있게 하는 나만의 트리거 포인트 찾기
• 글을 쓰기 위한 특정 시간 정해 보기
  • Ex) 자기 전, 아침 9시
• 글이 잘 써지는 나만의 환경 찾아보기
  • Ex) 카페, 안경 닦은 직후, …
• 한 문장을 매일 쓰는 습관을 들이고 점점 늘려보기
• 목표를 작게 잡고 점차 늘려가기
  • 1 단락, 1페이지 등등..

 

글쓰기 시간이 오래 걸리는데ㅠㅠ

• 글은 빨리 못 쓰는 게 당연하다
• 짧게 소소하게 쓰는 연습부터 하자
• 퇴고를 위해 시간을 들이는 건 좋다
• 전체 기간 중 40%는 퇴고에 할애하는 것이 좋다

 

내 글을 누가 본다는 두려움 극복법

• 기술문서는 사실을 써야 하는 게 중요하므로 사실을 지적받는 걸 두려워하면 안 된다.
  • 사실 검증을 위한 여러 번의 테스트가 필요하다 → 사실이 아니라고 뭐라 할 수 없게끔 쓰려고 노력한다
  • 피드백을 받으면 감사한 마음으로 글에 반영하자
• 두려움 극복은 쉽지 않다. 일할 때 내 코드를 공개하고 코드리뷰 받으며 성장해온 경험을 기억하면서 맷집을 키워보자.
• 자신의 글의 수준에 대한 두려움을 가진다면, 그 어떤 글도 누군가에게는 도움이 될 수 있으니 두려워말자 (실제로 생초보 대상 글이 가장 인기가 많다. )

 

상대가 이해하기 쉬운 글쓰기 방법

• 대상 독자를 한정시킨 글을 먼저 써본다
• 독자 페르소나를 설정해본다.
  • Ex) 2-3년 차 개발자로 자바스크립트에 대한 이해가 있다
• 그 특정 독자에게 말한다는 느낌으로 편하게 작성해보고 검수

 

여기저기 참조하다 보니 남의 글 집합이 된 것 같다. 어떻게 하면 나만의 글을 쓸 수 있을지?

• 초보자는 이렇게 되는 게 당연하다
• 걱정 말고, 지금은 내 글의 비율이 적더라도 조금씩 내 스킬을 키우면서 내 글의 비율을 늘려가면 된다
• 권위자의 글을 참조 인용하는 것은 내 글의 신빙성도 올릴 수 있다
• 인용에 대한 내 생각, 후기를 붙이는 것도 기술 글쓰기의 시작점이다

 

회사 코드 & 인용 참조 등 어느 범위까지 공개를 해도 될지?

• 인용 참조는 출처를 반드시 명확하게 밝혀야 한다
• 회사마다 공개 가이드가 있을 것이다. 만약 없을 경우 시니어에게 확인을 받고 내부적으로 한번 확인을 받은 후 공개한다.
• 혹시 공개가 안된다면 코드를 축약하거나 전체적인 형태만 알 수 있도록 변형하는 방법도 있다.

 

참조 복사본 중 원본 찾는 법

• 신빙성 있는 잡지사, 뉴스, 외국 정부기관, 조직, 학교, 기 출판 책 등에서 먼저 찾는다
• 집요한 마음으로 찾는다
• 개인 블로그 참조는 지양하는 것이 좋다

 

책 내용 인용 범위

• 이미 공개된 책이므로 인용 출처만 적는다면 정해진 범위는 없다
• 직접 인용일 경우 큰따옴표로 감싸기, 간접 인용이라면 문장 내에 녹여낸다
• 책의 문장과 너무 비슷하게만 쓰는 것이 걱정이라면, 우선은 그렇게 라도 글을 써보는 것이 도움이 된다
  • 나와 비슷한 경험을 한 누군가에게는 나를 거쳐간 글이 더 도움이 될 수도 있다

 

글 피드백받는 법

• 내가 어떤 피드백을 원하는지 체크리스트를 만들어서 리뷰어에게 전달해주면 좋다
• 피드백 체크리스트 예시
  • 의도한 바가 제대로 전달됐는지
  • 도입부가 매력적인지 (=글을 읽고 싶어지게 하는지)
  • 글이 전체적으로 하나의 내용을 얘기하고 있는지
  • 글쓰기 습관으로 인해 글을 읽는 데에 방해되는 요소가 있는지

맞춤법 띄어쓰기 잘하는 법

• 맞춤법 무조건 틀렸으리라 생각하고 글을 쓴 후에 맞춤법 검사기 사용하기
• 툴 : 네이버 맞춤법 검사기, 부산대 맞춤법 검사기, 국립국어원 카카오톡 채널