좋은 글을 쓰는 방법 feat 기술 블로그
글의 형식을 정하라
글을 쓰기에 앞서 내가 쓰는 글의 형식을 정해야한다. Daniele Procida님의 아무도 알려주지 않는 문서화의 비밀에선 기술 블로그의 형식은 4가지로 나눠진다.
- 튜토리얼
- 핵심 : 내가 배운 것을 초심자가 보고 따라할 수 있도록 하는 것
- 모호하거나 추상적인 개념 대신 정확한 단계로 설명할 것
- 내가 쓴 아무 문제 없이 튜토리얼은 작동해야한다
- 하우 투 가이드
- 핵심 : 구체적으로 어떻게 문제를 풀었는가
- 어떤 개념인지 설명하기보단 보여줘야할 목표나 결과에 집중한다
- 이미 유저는 그 개념을 알고 들어왔거나, 따로 찾아볼 것이다.
- 해설(설명)
- 핵심 : 단순 묘사 대신 대상을 분석하고 이해한 것 설명
- 여러 관점에서 살펴보고 내 의견을 나눈다
- 설명하는 것에 대한 뒷배경도 같이 곁들인다.
- 왜 이런 생각을 하게 되었는가
- 여러 옵션과 선택지들에 대해 토론하라
- 왜 이 방법을 골라야하는가?
- 레퍼런스
- 핵심 : 기술 묘사
- 명확하고 정확해야한다
- 코드 중심으로 묘사하라
처음엔 익숙하지 않아 깜박할 수 있다. 그래서 나같은 경우 scaffold를 수정하여 주석을 달았다. 포스트를 생성할 때마다 주석을 보고 내가 쓸 글의 형식이 무엇인지 생각하게 된다
글감을 정리하라
키워드던 짧은 문장이던 상관 없으니 내가 써야할 글감을 적어두어야한다. 생각은 계속 흐른다.
스쳐지나가는 생각들을 적어두지 않으면 금방 잊혀진다.
초고까지 쓰지 않더라도 괜찮다. 적어둔 글감들은 나중에 글을 쓸 때 기억의 트리거로 작용한다.
구체적으로 기록할거라면 Notion을 추천한다. 일종의 온라인 커스텀 노트인데 자신의 기준대로 내용을 정리해둘 수 있다. 태그나 링크도 추가 할 수 있다.
난 주로 아이폰 메모 앱으로 생각날 때 키워드만 적어놓고 글을 쓰면 지워버렸었다. UI가 단순하고 빠릿해서 자주 썼었다.
요즘은 구글 태스크를 이용한다. 구글 계정 내에서 연동되어 접근성이 뛰어나고, 가볍다. 구글 캘린더에 자동 지원이 되서 일정과 함께 관리할 수 있는데 편하다.
Comment