개발 블로그 쓰는 방법
개발 글을 포스트 할 때마다 마음속에 지니기 위해 정리한 글입니다..
개발 블로그를 쓸때의 마음가짐
블로그를 쓴다는 행위 자체보다는 무엇을 "왜?", "어떻게" 하는지가 중요하다.
만약 "왜?" 에 대해서 설명하지 못한다면 , 이 일을 하는 근거가 없으므로, 여러 상황을 고려하지 않고 진행했을 것이라는 평가를 받을 가능성이 높습니다. 따라서 글을 쓸 때, 이 글을 왜 쓰는지에 대해서 생각하며 글을 써야 합니다.
글의 내용
블로그 글은 자신이 공부한 내용을 정리하는 개인 공부 노트로 사용되는 경우가 많다. 어려운 개념을 설명한 경우 자신의 기술력을 인정받을 수 있지만, 간단히 개념 글을 옮겨 적는 수준의 글의 경우 열심히 했다라는 평가를 받을 뿐 잘한다는 평가는 받기 어렵다.
그렇담 글을 어떻게 써야 할까?
1. 공부한 내용이 아닌 활용한 내용을 적자.
=> 개발은 암기가 아닌 이해가 중요하다. 단순히 공부만 한 것은 암기일 수 있다. 단순히 공부한 내용이 아닌 프로젝트에 활용해 개선해 본 경험이라면 이는 이해를 했다고 볼 수 있다.
2. 개념 정리를 하더라도 깊게 하자
=> 단순히 특정 개념에 대해 소개하는 글보다는 개념의 장점/단점, 내부 동작 원리까지 깊게 설명해 주는 글을 작성 하는것이 좋다. 이러한 글이 다른 사람에게 더 도움이 될 수 있고, 더 퀄리티가 높다.
3. 이미지를 잘 활용하자
=> 다른 사람이 잘 이해 할 수 있도록 이미지를 잘 활용하자
=> 프로젝트의 구조나 설계에 대한 의도를 설명할 때에는 그림이 효과적이다. draw.io 가 쉽게 다이어그램이나 이미지를 만들 수 있다.
4. 문단을 잘 나누자
=> 적당하게 문단을 나눠주면 읽는 사람이 조금 더 편하게 읽을 수 있다.
5. 링크를 잘 활용하자
=> 글에서 설명하기엔 너무 방대한 개념에 대해서는 직접 줄줄이 늘어놓으면서 설명하기보다는 독자가 직접 들어가서 파악할 수 있도록 공식 홈페이지나 레퍼런스의 링크를 달아주는 것이 좋다.
6. 글의 스타일도 잘 입히자
=> 굵게, 기울임체, 리스트 등 활용해 글의 가독성을 높여주자.
참고 링크
개발 블로그는 어떻게 써야할까?
안녕하세요. 멘티가 좋은 개발자로 성장할 수 있도록 서포트하는 개발자 멘토링 기관 F-Lab 입니다.
f-lab.medium.com