개발자 글쓰기는 어떻게 해야 하는가

개발 공부를 하며 자주 들었던 조언은 바로 '블로그를 운영하라.' 였다.

그렇기에 기술 블로그를 따로 만들어 내맘대로 글을 작성하곤 했는데, 그들이 조언해준 건 단순히 블로그를 운영하라는게 아니었다.

지금 와서 알게 됐지만, 블로그를 운영하라는 조언은

글쓰기 능력을 키우고 문서화를 제대로 하는 연습을 하라는 뜻이었다. 

 

 

아직 공부를 하는 입장에서 왜? 라는 의문이 들었고 여러 블로그를 찾아봤다. 

(개발자 글쓰기라는 책도 있었음.)

 

 

 

🎅 글쓰기를 해야하는 이유

1. 기억에 오래 남는다.

: 단순히 기술을 배우는 것보다 배우는 과정에서 생기는 오류를 해결하는 과정에서 얻는 것이 많다. 학습 & 오류 내용이 당시에 이해가 됐더라도 장기 기억이 되긴 어렵다. 기록은 그런 단점을 완벽하게 보완해준다.

 

2. 더 명확하게 정리할 수 있다.

: 글을 쓰다보면 머리 속에 있는 내용을 훨씬 명확하게 정리할 수 있다. 알고 있다고 생각한 내용도 막상 글을 써보면 작성하기 어려운 경우들을 맞닥뜨리게 된다. 글쓰기를 하면 어렴풋 알고 있는 지식을 근거와 논리를 기반으로 정리할 수 있다. 다시 회고해볼 수 있는 기회도 되는 듯.

 

3. 퍼스널 브랜딩의 기반이 된다. 

: 블로그를 보면 그 사람을 알 수 있다. 어떤 기술에 관심이 있고 어떤 과정을 거쳐 성장해왔는지 히스토리를 파악할 수 있다. 

 

4. 개발자의 핵심 역량인 소통의 기반이 된다. 

: 구인 공고를 보면 소통(커뮤니케이션) 능력을 필수 요건으로 넣어둔 경우를 자주 볼 수 있다. 그만큼 커뮤니케이션 능력이 중요하다는 것인데, 이 능력의 베이스는 문서화다. 문서화는 글쓰기를 대충하는 사람에게 주어질 수 없는 능력이라 생각한다. 

 

 

 

 

개발자는 혼자하는 직업이 아니다.

계속해서 협업을 한다. 

이 과정에서 어떤 이슈에 대해 문서화, 즉 이슈에 대한 정리가 제대로 되어있지 않다면

팀원들의 시간을 뺏게 될 것이다. 

이전에 회사 다닐 때의 경험을 떠올려보면,

엉망인 이메일 때문에 하루를 날리는 경우도 있었다. 

(외국에 있는 생산 라인과의 커뮤니케이션이 특히 중요했다. 과장님 혹은 부장님의 컨펌을 꼭 받아야했음.)

 

 

그렇다면 어떻게 글을 써야 좋은 개발자 글쓰기가 될까?

정리를 잘 해놓은 블로그들을 보면 읽기도 편하고 어떤 이슈에 대한 글인지 한 눈에 들어온다.

 

 

 

🦌 개발자 글쓰기의 핵심

1. 글의 목적과 방향성 (독자 선정)

: 글의 목적과 방향성은 독자에 의해 결정된다. 이 글을 읽을 독자가 누구인지에 따라 글의 방향은 많이 달라질 것이다. 

이 내용을 읽게 될 미래의 나(까먹었다고 가정했을 때), 같이 일하는 팀원 등을 독자로 선정한다면 대충 쓰지는 않을 듯.

 

2. 정확성, 간결성, 가독성

: 개발자가 쓰는 글은 소설, 수필이 아니다. 비지니스 글이며, 비지니스 글은 위계가 있어야한다. 

핵심 내용

-세부 내용1

-세부 내용2

이런식으로 한 눈에 들어오는 구성이 중요하다. 

 

 

 

 

 

 

+ 잘 된 블로그들을 참고해 어떤 식으로 글이 작성되었는지 살펴볼 예정이다.

 

 

 

 

 

참조 사이트

https://dev.gmarket.com/30

개발자의 글쓰기는 다르다.