기술블로그 쓰는 방법 공유 - 오름캠프
목차
기술 블로그 쓰기
오름캠프에서 블로그 쓰기 활동을 하면서 훈련생 분들에게 ‘기술 블로그 쓰는 방법 공유’ 부탁을 몇 번 받았습니다. 글을 대단히 잘 쓰는 사람은 아니지만 기술 관련 글쓰기 처음 쓰는 사람들에게는 도움이 될 수도 있겠다 싶어서 제가 쓰는 방법을 공유할까 합니다.
다음과 같은 프로세스로 글쓰기를 진행합니다.
- 글쓰기 주제 선정
- 가상의 독자 선정
- 글 구조 짜기
- 글 작성
그럼 프로세스 별로 하나씩 공유해 보도록 하겠습니다.
글쓰기 주제 선정
가장 먼저 생각하는 것은 당연하게도 글쓰기의 주제입니다. 글 쓸 거리가 있어야 글을 작성하니까 말입니다. 예전에 오름캠프에서 진행되었던 블로그 세미나에서도 나왔던 말이지만, 내 주변의 모든 것이 주제가 될 수 있습니다. 주제가 작을 수도 있고 클 수도 있습니다. 간단한 파이썬 문법에 대해서, Django의 특정 기능에 대해서, 프로젝트를 하면서 배운점에 대해서 등 그 어떤 것도 될 수 있습니다. 개발자는 평생 공부하는 직업인데 공부한 걸 주제로 적으면 됩니다.
그리고 공유의 관점에서 주제를 선정합니다. 3가지 정도가 될 수 있겠는데요.
- 지식 공유
- 정보 공유
- 경험 공유
다음은 실제로 작성했던 글 주제의 목록입니다.
- Redis 따닥 방지(중복 방지) 하기 - FastAPI (지식 공유)
- 잘 몰랐던 것을 공부하고 내용을 정리해서 공유한 내용입니다.
- IDX - Google이 만든 웹 기반 IDE 알아보기 (정보 공유)
- 새로 알게된 정보를 정리해서 공유한 내용입니다.
- CloudWatch 로그 정규 표현식으로 검색하기 (경험 공유)
- 실제 경험했던 실수를 정리하고 공유한 내용입니다.
사실 3가지로 나눴지만 어떻게 보면 비슷비슷 합니다. 이렇게도 생각해 볼 수 있다는 것입니다.
가상의 독자 설정
인터넷 상에 공개된 블로그는 누구나 접속해서 내가 작성한 글을 읽을 수 있지만 내가 글을 읽는 가상의 독자를 내 맘대로 설정합니다. 사실 이 과정은 나의 글 쓰기에 자신감을 불어 넣기 위함 입니다. 글을 쓰려고 하는데 ‘나는 아는게 별로 없고 공부 길게 하지 못했는데… 내 글을 퍼블릭한 공간에 올리기가 좀 그런데..’ 라는 생각을 초보일 수록 하게 되는 것 같습니다. 그런데 가상의 독자를 나보다 경험이 적은 사람으로 설정하면 그래도 자신감이 올라가는 기분이 듭니다.
저는 거의 대부분 가상의 독자를 3년 경력 미만의 백엔드 개발자로 지정하고 글을 씁니다. 일단 독자가 저보다 경험이 적고 익혀야 할 기술이 많겠네요. 그렇게 정하고 나니 글의 스타일을 친절하게 설명해주는 느낌으로 가져가게 됩니다.
- A는 ~입니다.
- 저는 ~ 생각합니다.
- ~게 해보세요.
- ~게 하면 좋을 것 같습니다.
글 구조 짜기
글을 쓰기 전에 어떤 구조로 글을 작성할 것인가 구조를 짭니다. 최근 1년 정도 동안, 길이가 긴 글은 잘 작성하지 않았습니다. 그 이유는 어짜피 사람들이 내 글을 막 찾아서 읽지 않는데, 전체 길이까지 길다면 누가 제대로 읽어줄까 생각했습니다. 간결한 글을 위해서 다음과 같이 설명문의 구조를 가져갑니다. 기술에 대한 글을 쓸 때 좋은 구조 같습니다.
- 짧은 머리말 - 머리말에서 내가 어떤 걸 쓸 것인지 혹은 왜 쓰는지 등을 간결하게 작성합니다.
- 오늘은 Django Model 기초에 대해서 작성해보겠습니다.
- 핵심만 본문 - 주제에서 다루고자 하는 주제의 핵심 내용을 적습니다.
- Django Model에는 ~필드가 존재합니다. Model은 ~ 작성합니다. Meta 클래스는 무엇이고 ~ 속성들을 넣을 수 있습니다.
- 깔끔한 맺음말 - 전체를 요약하거나 마무리 문장을 적으며 마무리 합니다.
- Django Model 기초에 대해 알아봤습니다. Django Model은 중요하니까 잘 공부해야합니다.
이런 틀안에서 글을 작성할 수 있습니다. 글의 여러가지 포맷 중에 이것이 처음에 적용해보기 좋은 포맷인 것 같습니다.
글 작성
구조까지 얼추 잡히게 되면 큰 그림은 그린 것이니 그대로 따라가며 글을 작성하면 됩니다. 다음 요소도 중요하게 생각합니다.
- 한 문장, 한 문장을 길게 쓰지 않습니다. 글 쓰기의 정말 고수가 아닌 이상 문장이 길어지면 이해하기 어려운 문장이 많이 생성되는 것 같습니다.
- 적절한 소제목을 작성합니다. 소제목 아래에 쓸 내용의 주요 키워드들을 담아서 작성합니다. 그리고 그것은 전체 글의 제목과도 연관성이 있는게 좋겠죠.
- 적절한 기능들을 사용합니다. 적절한 이미지 사용, 열거가 필요할 때 • , 코드가 필요할 때 코드블록, 중요한 부분 볼드 등 - 블로그를 작성해 보신 분들이라면 다 아실거라고 생각합니다.
글을 열심히 쓰고 일단 발행합니다. 그리고 수정이 필요하면 수정하면 됩니다.
마무리
제일 중요한 부분을 이야기 안 했는데요. 아마 다들 아실거라고 생각합니다. 꾸준하게 쓰는 것. 노하우고 뭐고 간에 꾸준히 쓰지 않으면 늘지 않는 것 같습니다.
저는 글을 어떻게 쓰는지에 대해서 공유를 해보았습니다. 글을 통해 내가 알고있는 것을 나누는 것의 즐거움을 알아가셨으면 좋겠습니다. 저도 수준있는 기술블로그를 작성하기 위해 계속해서 정진해야겠습니다.