개발자도 글을 잘 써야 한다고요?! 우아한 테크세미나 정리

 

Developer Relation(DR)팀 조은옥님의 도입부 설명

 

 

우아한테크 블로그는 지금..

• 글을 통해 경험을 공유하고 있음
• 월 평균 조회수 15만회 이상

 

우아한형제들이 글쓰기에 진심인 이유?

• 개발자는 지식 노동자! (송재하 CTO)
  • "지식의 공유가 곧 기술 커뮤니티를 향한 공헌이자 개인역량과 영향력의 강화입니다."
  • 글쓰기를 통해 지식의 공유를 더 활발히 하고 우아한형제들의 개발자분들이 자신의 역량과 영향력을 더 키워 커리어적 성장을 이룰 수 있도록 적극 지원하고 싶음

 

Developer Relation(DR)팀 유영경 테크니컬 라이팅 코치 님의 진행

 

개발자를 위한 글쓰기 가이드

 

1. 테크니컬 라이팅이 된 계기?

• 우연이지만 운명적이었다.

 

2. 독자를 생각하는 의지가 중요하다.

 

3. 글쓰기 어떻게 시작해야할까? 기술 글쓰기의 특징

• 특정 독자를 대상으로 함
• 특정 목적을 갖고 있음
• 특정 정보를 전달함

 

4. 인문학적 글쓰기 vs 기술 글쓰기

	인문학적 글쓰기	기술 글쓰기
내용	창의, 상상, 상징	사실
대상	일반인	특정인
형식	자유	표준적, 학문적
구성	자유	순차적

 

5. 왜 글을 쓰는가

• 글쓰기 능력은 모든 학문의 기초다. 생각을 글로 표현하지 않고 능력을 입증할 방법은 없다.
  • 글쓰기 교수 3인이 말하는 '글을 잘 쓰려면', The JooAng, https://www.joongang.co.kr/article/455771
• 나의 이야기를 남기고 싶다.
• 나의 이야기를 공유하고 싶다.

 

6. How Projects Really Work

• "How Projects Really Work (version 2.0)"(2018), https://www.zentao.pm/agile-knowledge-share/tree-swing-project-management-cartoon-97.mhtml
• 완벽하게 작성된 문서로 소통했다면, 문제는 발생하지 않았을 것!

프로젝트의 의사소통

하지만 문서화는?

다뤘던 내용 정리

• 글 한 편 완성하기란 원래 어렵다.
  • 글 한편을 쓰는건 어려우니 넉넉히 6-7주를 잡자!
  • 길게는 2년까지도 걸림
• 무엇을 쓸지 생각하기
  • 모두 쓸거리
    • 새 환경 적응기
    • 개선 사례
    • 시행착오 경험담
    • 작업 절차
    • 특정 기능 활용법
  • 직접 경험한 것 or 나의 이야기
    • "쓸거리가 있어서 쓰는 것이 아니다"
      • 쓰고자 하면 모든 것이 쓸거리
  • 주제를 정한다.
    • 주제는 글감이라고도 하며, 내용, 메시지, 테마 등이 함께 뒤섞인 말
    • 작성자와 독자 모두 관심이 있는가
    • 충분한 자료를 찾을 수 있는가
    • 일정 내에 쓸 수 있는가
  • 소재 모으기 & 정리하기
    • 외부 자료 조사
    • 메모 또 메모
    • 필요한 자료를 찾고야 말겠다는 다짐을 유지하며 각성한 상태로 찾는다.
    • 출처를 모두 기록해 놓는다.
      • 메모가 자산이다.
    • 백 마디 말보다 숫자가 효과적이다.
      • 근거, 사례, 숫자
    • 구체적으로 제시한다.
      • 불과 얼마 전까지만 해도 데이터 센터에 관심이 없었다. -> LEED platinum 인증을 받기 전까지 데이터 센터에 관심이 없었다.
• 대상 독자 정하기
  • 대상 독자에 따라 기술 깊이를 조절한다.
  • 구체적으로 대상 독자를 정하고 글을 쓴다.
  • 경력 2~3년의 IT 분야 개발자
  • IT 관련 전공 대학원생 혹은 대학생
  • 비전공자 
  • 직접 경험한 이야기로 주제 좁히기

• 초안 작성하기
  • 세부 목차를 꼼꼼하게 잡고 1페이지부터 쓴다.
  • 어디서부터든 일단 쓴다.
    • 자신 있는 부분부터 쓴다.
      • 문장을 쓴다.
      • 문장을 조합해 단락을 만든다.
      • 단락을 조합해 절을 만든다.
      • 절을 조합해 장을 만든다.
  • 생각나는걸 말로 해서 녹음한 뒤 글로 만들기도 함
• 글 고치기
  • The first draft of anything is shit
    • "모든 초고는 걸레다" (어니스트 해밍웨이)
  • 글쓰기의 본질은 고치기
    • 이제 다 썼다고 생각한다.
    • 맞춤법과 띄어쓰기 수정에 가장 집중한다.
    • 쓰자마자 바로 검토한다.
    • 공개하기 부끄러워서 혼자서만 보고 또 본다.

 

자기가 지은 것으로 보지 말고
다른 사람이나 평생 심히 미워하는 자의 시를 보듯 하여
그 하자를 열심히 찾아도 찾지 못하면
비로소 세상에 내놓을 수 있는 것이다.

 

이규보, "동국이상국집"

 

---

김민석 (전) 테크니컬 라이팅 코치 님의 진행

 

더 나은 글을 쓰는 방법

 

1. 습관과 루틴

• 1~2분 짜리 짧은 글을 써보자

 

2. 피드백을 받자

• 대상 독자와 비슷한 동료에게 피드백을 받아보자

 

3. 나의 글쓰기 환경을 만들어보자

 

4. 내 글을 누가 읽을지? 상상하며 써보기

• 독자를 특정인으로 선정 한 후 열심히 설명하듯

 

5. 어느정도 인용하고 어느정도 참조할지 정해두고 써보기

 

6. 나의 언어로 해석하는 후기, 생각을 써서 시작해보자

 

7. 출처 링크는 필수~ 내부에서 확인은 필수

• 중요한 코드는 공개되지 않도록 주의하기
• 집요하게 추적을 한다

 

8. 소재를 찾기 위해서 항상 메모하는 습관을 들이자

 

9. 글쓰기 피드백을 받는 꿀팁! 피드백 체크리스트를 작성해보아요

• 하고자 하는 말이 잘 전달 됐는지
• 도입부만 봤을 때 읽고 싶은지
• 흐름이 벗어난 게 없는지
• 독자가 이해하는데 방해되는 부분이 없는지

 

글 쓰기 꿀팁

 

메모를 하자! 메모를 잘 하려면?

 

• 쉬운 형식으로 반복해서 작성이 가능해야 함
• 각 메모가 연결되어 있는지 파악을 할 수 있어야 함
  • 제텔(zettel:종이, 쪽지, 메모) + 카스텐(kasten:상자, 서랍)
• 메모를 효율적으로 관리 하고 싶다면 - 제텔카스텐
• 관심 분야에 대해 완벽한 문장으로 된 메모를 조금씩 작성해 보자!

 

1. 매일 새롭게 알게 되는 지식을 다른 사람이 읽어도 이해할 수 있게 짧은 메모를 작성해 보세요.

2. 새로 작성된 메모와 기존 메모의 연결고리를 생각해 보고 기존 메모와 연결해 보세요

3. 연결된 메모에서 공통된 소재를 발굴해 보세요

4. 특정 소재와 관련된 메모가 어느 정도 쌓이면 발굴된 소재로 글을 작성해 보세요

5. 부족한 부분에 대해서 학습 후 메모를 추가해 글을 보강해 보세요

 

Tip. 한 문장 메모는 바로 활용 가능하게 완성도를 높여서 작성하면 좋아요!

 

option : 김민석 전 테크니컬 코치는 옵시디언(obsidian) 툴을 사용한다고 함

 

제텔카스텐 장점

1. 단순한 메모 방식 -> 쉽게 습관을 만들 수 있음
2. 내가 관심이 있는 소재가 뭔지 파악할 수 있고, 내 관심사에 집중할 수 있음
3. 새로운 메모가 연결되면서 글을 쓸 수 있는 다른 아이디어가 생겨남

 

마지막으로..

 

맞춤법 오류를 꼭 확인한다

• 네이버, 다음을 활용해 맞춤법 검사기를 사용한다.
• 맞춤법을 확인해서 신뢰성을 높이자

 

간단 후기

- 실제로 공감이 되는 것도 많았고, 글 쓰기의 중요함을 다시 상기 시켜주는 재밌는 세미나 였다.

- 다 안다고 생각했지만, 놓치고 있는 것들도 많았다..

- 완성도 있는 한 줄 메모가 인상적이었다~ 소재만 모으는 나를 반성해본다.. 🥲

- 본인도 이 글을 3~4번 정도 고쳤다!

 

끗