본문 바로가기
회고/네이버 부스트캠프 9기

글쓰기, 개발자가 꼭 배워야 할 기술 (+실전 TIP)

by NewCodes 2024. 12. 18.

 

안녕하세요, 부스트캠프 웹・모바일 9기

Web 캠퍼 김상혁입니다.

 

멤버십에서는 매주 월요일 캠퍼끼리

‘기술공유’ 시간을 가집니다.

 

이번에는 제가 기술공유에 신청했었습니다!

 

야 너도 글 잘 쓸 수 있어”를 주제로

160명의 캠퍼분들 앞에서

30분간 이야기를 나눴습니다.

 

해당 포스팅에서는 기술공유에서 다뤘던 내용을

글로 여러분과 함께 공유하고자 합니다.

 

가만히 앉아서 심박수 140을 찍다..

 

기술공유 당일 날 모습입니다!

 

이때 했던 것처럼

여러분에게도 생생하게 들려드리겠습니다 😊

 

바로 시작해보시죠!

 


📍 본격적으로 시작하기에 앞서

개발자 여러분! 글쓰기 막막할 때가 많으셨죠?

 

이 글 하나로 뻥 뚫어드리겠습니다! 끝까지 믿고 따라와주시면 감사하겠습니다.

 

크게 다섯 가지 내용을 다뤄보려 합니다!
  1. 필요성: 우리는 왜 글을 써야 할까?
  2. 본질: 글쓰기에서 가장 중요한 건?
  3. 가독성: 지금 당장 ‘읽기 쉬운 글’을 쓰는 방법
  4. 습관: 글쓰기를 습관화하기
  5. 실전: 블로그 글쓰기 전략

 

해당 글을 읽으실 때 주의사항이 있습니다!
  1. 개인적인 의견이 다소 포함되어 있습니다.
  2. 해당 글을 읽는 것만으로는 효과가 없습니다.
  3. 문학적인 글쓰기가 아닌 정보성의 글쓰기를 다룹니다.

 


🧐 우리는 왜 글을 써야 할까?

 

개발자인 우리는 왜 글을 써야 할까요? 코드만 잘 작성하면 되는 거 아닐까요? ㅎㅎ 그 이유를 차근차근 짚어보겠습니다.

 

1. 협업

개발자는 협업을 하면서 글을 쓸 일이 많습니다.

  • 작은 단위의 커밋 메시지부터 시작해서 PR까지 올려야 하고요.
  • 프로젝트를 하며 개발 일지, 학습 정리, 트러블슈팅, README, 위키, 백로그 등을 작성해야 합니다.
  • 또한, 슬랙과 같은 메신저를 통해 진행 상황이나 이슈를 공유하기도 하죠.

 

2. 취업 준비 

포트폴리오

두 번째는 다소 현실적인 이유인데요. 우리는 취업 준비를 하며, 많은 글을 써야 합니다.

  • 자기소개서, 이력서, 포트폴리오 등을 통해 나를 소개해야 합니다.
  • 그 속에서 진행했던 프로젝트를 이해하기 쉽게 정리하는 것도 필요하죠.
  • 내가 정말 좋은 경험을 했더라도 서류를 통해 드러나지 않는다면 면접을 보기 힘들기도 하죠.

 

3. 학습 정리

멤버십 학습 정리 일부
 

마지막으로 ‘학습 정리’입니다. 개발자는 계속해서 새로운 지식을 습득할 줄 알아야 합니다. 이를 위해서는 직접 기술을 사용하는 등의 학습 방식이 있겠지만요. 결국엔 글로 정리해두는 것이 필요합니다.

 

학습한 내용을 글로 정리하는 건 장점이 많습니다!

  • 학습의 기회: 한 가지 학습 주제로 글을 쓰다보면 생각보다 막히는 부분이 많으실 겁니다. 잘 안다고 생각했던 것도 설명하기 어려울 수 있습니다. 이를 또 다른 학습의 기회로 삼을 수 있습니다!
  • 나만의 지식 창고: 글을 쓴 이후에 특정 개념이 잘 기억나지 않을 때 내가 정리해두었던 걸 꺼내 읽으면서 빠르게 복습할 수도 있고요.
  • 말하기가 쉬워지는 마법: 한 가지 주제에 대해 설명하는 글을 써두면, 나중에 면접할 때나 동료에게 설명할 일이 있을 때 설명하기 훨씬 더 수월합니다. 

 

여기까지 해서 개발자가 글을 써야 하는 이유에 대해 알아봤습니다.

 

‘협업, 채용, 학습 정리’

 

평소에 글쓰기 연습을 잘해둔다면, 위 세 가지는 훨씬 더 수월해질 것을 약속드립니다!

 

그럼 글쓰기는 어떻게 잘할 수 있을까요? 본질부터 알아봅시다!

 

 


🎯 글쓰기에서 가장 중요한 본질

 

여러분, 글쓰기에서 가장 중요한 것 하나만 꼽자면 어떤 게 있을까요? 기술공유할 때 캠퍼 분들의 다양한 의견을 들을 수 있었는데요. 논리, 가독성, 주제 등등 여러 키워드가 나왔습니다.

 

위 모두 정말 중요하지만, 제가 생각하는 글쓰기의 본질은...

 

독자’입니다.

 

생각해보면 독자가 없는 글쓰기가 있을까요? 일기가 떠오르실 수 있습니다. 하지만, 일기는 수년 뒤에 내가 읽게 되기 마련이죠. 일기마저도 미래의 나가 독자가 되는 셈이죠.

 

글쓰기는 나를 위한 게 아니라 글을 읽는 독자를 위한 행위입니다. 이 본질을 바탕으로 글쓰기라는 행위를 정의해보면요.

1. 독자에게

2. 나의 주장과 의견, 지식, 생각 등을

3. 정확하고 이해하기 쉽게 전달하는 것

 

 

그렇다면 읽는 사람을 고려해서 글 쓴다는 건 구체적으로 어떻게 하는 걸까요? 글을 쓸 때 저의 사고과정을 예시로 가져왔습니다.

🧐 ‘이 글을 읽는 대상을 누구로 잡을까?’

🧐 ‘독자가 이 단어의 뜻은 알까?’

🧐 ‘처음 보는 사람 입장에서 글이 잘 읽히나?’

🧐 ‘처음 보는 사람 입장에서 글의 흐름이 어색하진 않나?’

🧐 ‘이 문장은 쉽게 이해하기 힘들 것 같은데.. 어떻게 하지?’

🧐 ‘이 제목을 보고 호기심이 생길까?’

 

이렇게 저는 글을 읽는 사람의 입장에서 상상하며 글을 씁니다. 항상 글을 쓰다가도 독자의 관점에서 글을 바라보는 연습을 해보시면 정말 좋습니다.

 

물론 이게 처음 해보면 되게 어려울 수 있습니다. 그래서 읽는 사람을 고려한 글쓰기의 예시를 가져와봤어요. 제가 멤버십 학습스프린트에서 쓴 PR의 일부입니다.

 

PR의 내용을 간략히 설명

 

PR에 처음 들어왔을 때 개요를 통해 ‘이 PR은 누가 올린 것이고 어떤 컨셉으로 프로젝트를 진행하고 있는지’ 알리고자 했습니다. 또한, 해당 PR이 어떤 내용을 담고 있는지 한 문장으로 담아내고자 했습니다.

 

이렇게 작성한 이유는 독자를 고려했기 때문인데요. 위 PR의 독자는 멘토님입니다.

 

부스트캠프 웹・모바일에서는 멘토님께 PR 코드리뷰를 받는 활동이 있습니다. 이때 멘토님은 무작위로 6명으로 이루어진 특정 그룹에 배치가 됩니다. 멘토님은 저희가 누구인지도 잘 모르는 상태에서 코드리뷰를 남기셔야 하는 상황입니다.

 

멘토님의 입장에서는 업무를 끝내시고 주로 새벽에 PR을 봐주시는 경우가 많았습니다. 어떻게 하면 더 멘토님께 효과적으로 PR 내용을 전달할 수 있을지 고민했습니다. 그래서 위와 같은 개요를 쓰게 되었어요. 이렇게 하면 멘토님 입장에서는 ‘아~ 이 PR은 누가 올린 거고 이런 컨셉으로 올렸구나.’라는 걸 대략적으로 파악하고 읽으실 수 있어요.

 

이렇듯이 읽는 사람을 고려해서 글을 쓰면, 위와 같은 형태의 글이 써질 수 있어요. 물론 위는 한 가지 예시일 뿐입니다!

 

 


📝 지금 당장 ‘읽기 쉬운 글’을 쓰는 방법

 

읽기 쉬운 글을 쓰는 방법을 알아보기 전에 읽기 어려운 글을 먼저 알아보고자 해요. 우리는 이해하기 어려운 글을 읽을 때면 이 글이 뭘 의미하는지 단번에 머릿속에 들어오지 않을 때가 있죠. 읽기 어려운 글에는 아래와 같은 특징이 있습니다.

 

1. 문장이 다소 길다.
2. 한 문단이 너무 길다.
3. 수식어구가 많다.
4. 맞춤법이 여기저기 틀려있다.
5. 어려운 용어가 많이 나온다.
6. 글씨가 너무 작거나 자간, 행간 등이 다소 좁다.
7. 글을 다 읽고 나면 ‘그래서 핵심이 뭐지?’라는 의문이 든다.

 

위 7가지의 공통점은 ‘내가 쓰기엔 편하다.’는 점입니다. 글쓰기의 본질과는 다소 멀죠. 내 글을 읽는 독자가 많아질수록 글에 대해 더욱 신경을 많이 써야 합니다.

 

내 글을 읽어야 하는 사람이 100명이라고 가정해봅시다. 내가 작성한 글을 상대방이 이해하는 데까지 10분이 걸린다고 해볼게요.

 

여기서 글을 더 신경 써서 쓴다면 상대방이 이해하는 시간을 더욱 줄일 수 있겠죠? 10분에서 5분으로 줄어들었다고 해볼게요. 그러면 여러분은 독자의 소중한 500분의 시간을 아껴주는 것과도 같아요. 대략 8시간을 아끼는 셈이죠.

 

그런데 도대체 글에서 어떤 부분에 신경을 써야 상대방이 읽기 편할까요? 이제 읽기 쉬운 글을 쓰는 방법에 대해서 자세히 알려드릴게요.

 

1. 문장을 짧게 나누기

몇몇 분들이 가지고 계신 오해가 있는데요. 문장을 길게 쓴다고 해서 글을 잘 쓰는 건 절대 아닙니다.

 

기본적으로 하나의 문장에는 하나의 생각만을 담아주시는 게 좋습니다. 한 문장 안에 여러 개의 생각이 있으면, 읽는 사람 입장에서는 정보들이 머릿속에 차곡차곡 잘 들어오지 않을 수 있습니다.

 

처음부터 짧게 쓰려고 하진 말고, 하던 대로 쓰시고 나서 문장을 끊어보세요. 처음부터 이를 의식하고 쓴다면 글이 오히려 안 써지는 경우가 많기 때문입니다.

 

예시를 들어보겠습니다.

<Before: 긴 문장 예시>
나는 어렸을 때부터 학습법에 대한 고민과 관심이 많았으며 '이왕 하는 거 더 효율적으로 하면 좋으니까!'라는 생각이 늘 있었기에 학습법에 관한 책을 읽으면서 최적의 학습 루틴을 찾으려 했다. 

<After: 짧은 문장 예시>
나는 어렸을 때부터 학습법에 대한 고민과 관심이 많았다. '이왕 하는 거 더 효율적으로 하면 좋으니까!'라는 생각이 늘 있었기 때문이다. 그래서 학습법에 관한 책을 읽으면서 최적의 학습 루틴을 찾으려 했다.

 

<긴 문장 예시>
A* 알고리즘이란 '출발 노드에서 목표 노드까지의 최단 거리를 구하는 알고리즘'을 의미하는데 '에이스타 알고리즘'이라고도 하며, 최단 거리 알고리즘으로 유명한 다익스트라 알고리즘에 기반을 두고 있습니다.

<짧은 문장 예시>
A* 알고리즘이란 '출발 노드에서 목표 노드까지의 최단 거리를 구하는 알고리즘'을 의미합니다. '에이스타 알고리즘'이라고도 합니다. 이는 최단 거리 알고리즘으로 유명한 다익스트라 알고리즘에 기반을 두고 있습니다.

 

어떤가요? 하나의 문장에 하나의 생각만을 담는 게 어떤 의미인지 와닿으시나요? 만약 여러분이 읽어야 하는 책 한 페이지에 이렇게 긴 문장들만 있다고 생각해봅시다. 생각만 해도 읽기 어려울 겁니다. 

 

읽는 독자로 하여금 내 글을 해석하게 해서는 안 됩니다! 글이 자연스레 이해될 수 있도록 쉽고 명확하게 쓰는 게 좋아요! 이해하셨다면 다음으로 넘어가봅시다!

 

2. 범주 나타내기

‘범주 나타내기’는 제가 만든 용어인데요. 무엇을 말하려는지 먼저 간단하게 드러내는 것입니다.

 

예시부터 살펴보시죠! 제가 직접 주도했던 CS 스터디 중 일부 내용을 가져왔는데요. 빨간색 밑줄 위주로 봐주시면 됩니다.

 

https://github.com/BCS-study/basic-computer-science

 

빨간색으로 밑줄친 영역을 저는 ‘범주’라고 표현합니다. 그리고 이를 명시하면 독자의 입장에서는 읽기가 훨씬 편하다는 장점이 있습니다. 무엇을 말하려는지 먼저 간단히 드러낼 수 있어 독자 입장에서는 읽기에 수월합니다.

 

이렇게 범주를 나눠둔다는 것은 글을 구조화하는 것과도 같습니다. 그래서 우리 기억에도 잘 남기 마련입니다. 또한, 글을 바탕으로 설명해야 할 일이 있을 때 더욱 논리정연하게 의도를 드러낼 수 있습니다.

 

추가 예시로 제가 학습스프린트 하면서 올렸던 PR을 남깁니다. 빨간색 밑줄 위주로 봐주시면 됩니다.

 

 

그래서 ‘범주 나타내기’와 관련해서 드릴 수 있는 팁은요!

 

범주부터 나누려 하지 말고, 우선 글을 쭉 쓰다가 수시로 범주를 나눠보시는 걸 추천합니다. 처음부터 나누려 하다보면 글이 잘 안 써질 수 있어요. 저도 처음에는 여러 제약 조건을 신경 쓰지 않고 우선 써보는 편입니다.

 

3. 두괄식으로 작성하기

두괄식은 뻔하죠? ㅎㅎ 하지만 정말 중요하기에 넣었습니다.

 

말하기와 글쓰기의 공통점은요. 핵심을 먼저 드러내는 게 좋습니다. 핵심을 먼저 말하지 않으면, ‘그래서 전달하려고 하는 게 뭐지?’라는 생각을 자꾸 하게 됩니다.

 

아까 가져왔던 예시에서 두괄식으로 적어봤습니다. 빨간색 화살표 부분을 보시죠!

두괄식 예시

 

물론 핵심을 먼저 정리하는 건 어렵습니다. 그 대신 글을 다 쓰고나서 핵심을 한 문장으로 정리하여 제일 위 문장으로 배치해보세요! 이때 핵심 키워드가 꼭 들어가는 게 좋습니다.


 

여기까지 해서 지금 당장 읽기 쉬운 글 쓰는 방법에 대해 알아봤습니다.

 

1. 문장을 짧게 나누기
2. 범주 나타내기
3. 두괄식으로 작성하기

 

이 세 가지만 잘해도 이전보다 훨씬 더 가독성이 좋은 글을 쓰실 수 있을 겁니다!

 

 


🔄 글쓰기를 습관화하기

 

결국엔 우리는 글쓰기를 습관화해야 합니다. 처음에 소개드린 것처럼 개발자는 생각보다 글을 써야 하는 일이 많습니다. 그리고 무언가를 잘하기 위해서는 매일매일 습관을 들이는 것이 중요하죠.

 

먼저, 글쓰기를 습관화하면 구체적으로 나에게 어떤 장점이 있을까요?

 

글쓰기를 습관화하면 좋은 점

'메이플스토리' 아이템

 

글쓰기는 위 아이템처럼 ‘성장의 비약’에 비유할 수 있어요! 이 성장의 비약에는 5가지 효과가 담겨 있어요.

 

1. 사고력을 향상시킬 수 있습니다.
2. 전문성을 높일 수 있습니다.
3. 채용 과정에서 나를 더 잘 드러낼 수 있습니다.
4. PR, 문서화 등 글 쓸 일이 있을 때 거부감이 없어집니다.
5. 나의 생각을 정리하는 연습을 통해 말하기도 잘해집니다.

 

이 중 첫 번째 '사고력'에 대해서 더 설명하려 합니다. 2~5는 다들 공감하시리라 생각합니다. 

 

글쓰기를 하면 사고력이 좋아지는 이유는 ‘글쓰기 과정’을 들여다보면 밝혀집니다. 예를 들어, ‘프로세스와 스레드의 차이’에 대해 블로그 글을 써본다고 가정할게요. 좋은 글을 쓰기 위해서는 아래와 같은 과정을 거쳐야 합니다.

 

  1. 프로세스와 스레드에 대해 기존에 내가 알고 있던 지식을 장기기억에서 인출한다.
  2. 인출한 지식 이외에 글쓰기 위해 필요한 지식으로 추가 학습하여 정리한다.
  3. 기존에 내가 알고 있던 지식과 새롭게 알게 된 지식을 구조화하여 작성한다.
  4. 작성한 내용을 퇴고한다.

생각하는 것과 글 쓰는 것은 서로 다른 게 아닙니다. 위 과정을 보면 사고력이 안 쓰이려야 안 쓰일 수가 없습니다. 머릿속에 있던 걸 꺼내고, 추가 학습하며 구조화까지 해보는 경험은 사고력을 증진시키는 데 매우 효과적입니다.

 

항상 글쓰기를 ‘성장의 비약’처럼 여겨주세요!

 

글쓰기를 습관화하는 방법

글쓰기를 습관화하는 방법에 대해서는 크게 세 가지를 소개하려고 해요. 이는 바로 당장 실천해볼 수 있는 것이니 되도록이면 빨리 실천해보도록 해요!

 

첫 번째는 디스인센티브를 이용하는 것입니다.

사람은 본래 이득보다는 손해에 민감합니다. 이를 잘 이용해보면요. “내가 이번 주 블로그 글 하나 안 쓴다면 너에게 10000 원을 줄게.”라고 친구와 약속하는 겁니다. 내 돈을 잃지 않기 위해서는 어떻게든 글을 쓰게 되어있기 마련입니다.

 

두 번째는 단순화하는 것입니다.

하루에 10분이라도 괜찮으니 조금씩 써보는 겁니다. 10분도 길다면 딱 한 문장만 써본다고 생각해보세요. 그러면 어느새 글을 술술 쓰고 있는 나 자신을 발견할지도 모릅니다.

 

세 번째는사람과 함께 하기입니다.

이것도 사람의 본성을 이용한 건데요. 군중심리라고 많이들 들어보셨을 것 같아요. 주변에 있는 많은 사람들이 글쓰기를 한다면, 나도 덩달아서 글쓰기를 할 수밖에 없습니다. 주변 사람들과 함께 스터디를 해보시는 건 어떨까요?

 

‘디스인센티브’와 ‘사람과 함께 하기’를 적용한 'CS 스터디' 사례를 보여드리겠습니다. 

 

CS 스터디 모집 글 중 일부

 

제가 직접 올렸었던 CS 스터디 모집 글 중 일부입니다. 인프런 커뮤니티에 CS 스터디 모집글을 올려 사람들을 모집하고 6주간 스터디를 진행했던 경험입니다.

 

위 규칙들 덕분에 5명 모두 6주 간 스터디를 잘 마칠 수 있었어요! 보증금 차감과 제명 규칙을 통해 서로가 스터디에 더 집중할 수 있었죠. 그리고 스터디원과 함께 CS 내용들을 정리한 저장소는 깃허브 스타 151+개를 받기도 했습니다. 

 

이 사례를 통해 추가로 한 가지를 더 말씀드리려 합니다. 글을 쓰면 장점이 정말 많아요!

 

글을 잘 쓰는 것 또한 하나의 문제 해결 방법이 될 수 있답니다! 모집글을 잘 쓴 덕분에 좋은 사람들과 함께 공부할 기회를 얻을 수 있었어요.

 

저는 주변 지인 중에 개발하는 사람이 없었습니다. ‘어떻게 하면 함께 공부할 수 있을까?’를 고민했었습니다. 그러다가 온라인 스터디를 직접 모집했었어요!

 

또 어떻게 하면 온라인에서 사람들을 잘 모을 수 있을지를 고민했습니다. 그래서 모집글을 되게 신경 써서 작성했었어요.

 

구글폼 제출 결과

 

6일간 총 28명이 지원해주셨고, 이 중에서 4명과 함께 했어요. 많은 분들이 지원해주셔서 어떤 분들이 스터디에 정말 진정성 있게 참여할 수 있는지를 볼 수 있었어요.

 

이외에도 글을 잘 쓰면 얻게 되는 이점들이 정말 많답니다!

 

 


🚀 블로그 글쓰기 전략

 

이제 핵심은 다 말씀드렸습니다! 읽으시느라 수고 많으셨어요. 아래는 부록처럼 기획해본 내용입니다. 빠르게 소개드려볼게요!

 

글쓰기 갈래 추천

블로그에 어떤 글을 쓸지 막막하시나요? 그러면 집중해서 읽어주세요!

 

글쓰기는 크게 두 가지로 나눠볼 수 있습니다. 바로 필자 중심 글쓰기독자 중심 글쓰기입니다. 아래는 제가 주관적으로 난이도를 별로 측정해봤습니다.

<필자 중심 글쓰기>
1. 사진 위주의 일상 기록 ★
2. 특정 사건, 경험에 대해 느낀 점 ★★
3. 특정 사건, 경험에 대해 회고, 반성 ★★★
4. 자아 성찰 ★★★★
5. 시, 소설, 수필 등의 문학 글쓰기 ★★★★ ~

 

<독자 중심 글쓰기>
1. 학습한 내용을 설명하는 글쓰기 ★★★
2. 하나에 깊게 파고들며 ‘왜?’를 설명하는 글쓰기 ★★★★
3. 특정 사안에 대해 주장하는 글쓰기 ★★★★
4. 문제를 해결하고 고민한 과정 작성하기 ★★★★
5. 특정 제품 혹은 서비스를 홍보하는 글쓰기 ★★★★
6. 논문 및 보고서 작성하기 ★★★★★

 

해당 난이도, 본인이 이전에 어떤 글을 써본 경험이 있는지에 따라 적절한 글 갈래를 선택해보세요!

 

내 글이 검색되려면?

블로그 글을 열심히 썼는데도 불구하고 내 글이 검색이 안 된다면 속상하겠죠?😭 글을 다 쓰시고 나서 아래 체크리스트를 점검해보시는 걸 추천드립니다!

✅ 잠깐! 맞춤법 검사하셨나요?
 적절한 사진이 들어갔나요?
 나만의 진솔한 이야기가 담겼나요?
 중요한 문장 및 단어에는 스타일 속성이 들어갔나요?
 감정표현이 담겼나요?
 글 초반에 궁금증, 몰입, 집중을 유도하셨나요?
 제목이 핵심을 담으면서 누르고 싶게 생겼나요?

 

추가로 블로그 플랫폼을 사용하고 계신다면, 해당 플랫폼에서 SEO 최적화를 어떻게 하는지 알아보는 것도 좋습니다!

 

마지막으로 글을 돌아보실 때 독자가 내 글을 읽고나서 공유할만한 글일까?를 생각해보세요. 여러분이 정말 잘 읽은 글이 있다면 이를 공유해본 경험이 한 번쯤은 있을 거예요! 그런 글들을 쓰려면 어떻게 해야 할지 생각해보는 것도 도움이 되실 겁니다 😁

 

 


⭐️ 정리

이번 글에서의 핵심을 정리해보겠습니다.

 

1. 글쓰기는 독자를 위한 행위이다.
2. 가독성은 '짧은 문장, 범주 나누기, 두괄식' 세 가지만 해도 비약적으로 좋아진다.
3. 글을 왜 써야 하는지 스스로 납득하고 실천하자.

 

중요한 건 우선 써보는 것’입니다!!!! 키워드만 쓰셔도 좋고요. 몇 문장만 쓰셔도 좋고요. 어떠한 형태로든 일단 써보시는 걸 적극 권장합니다! 

 

글을 더 잘 쓰고 싶다면 이 글을 다시 참고해보세요!

 

여러분의 글쓰기를 응원합니다 😊