블로그를 운영하면서 글 쓰는 것이 막연하다는 생각을 자주 했습니다.
그러나 이 책을 통해 개발자의 글쓰기는 기술적, 단계적으로 훈련이 가능하다는 것을 알았습니다.
유익한 내용이 굉장히 많았던 책이어서 대여해서 읽은 뒤 바로 구매했습니다. 👍
개발자의 글은 정확하고 간결하며 가독성이 높은 글로 정의할 수 있습니다.
그리고 이 책은 변수명부터 문서까지 전반적인 글쓰기 기술들을 소개하고 있습니다.
개인적으로 느낀 이 책의 핵심 포인트가 2가지 있습니다.
첫째, 개발자의 글쓰기는 일련의 추상화 과정과 닮았다는 것
둘째, 무엇보다 독자를 고려하면서 써야하는 것
이 2가지 본질을 항상 기억하면서 글을 쓰다보면 나만의 글쓰기 철학이 생길 것입니다.
두괄식
두괄식은 먼저 핵심과 결론을 주장하고, 뒤에 근거와 설명을 풀어내는 방식을 의미합니다.
쓰는 입장에서도 쉽고 간결한 문장 구조이면서, 읽는 입장에서도 요점 파악이 쉽습니다.
저 또한 포스팅을 위해 여러 블로그를 참고하다 보면 두괄식으로 작성된 글이 가장 읽기 좋았습니다.
글쓰기가 아직 어렵거나 미숙하다면 두괄식으로 차차 글을 써보는 것을 강추! 합니다.
서술식, 개조식, 도식
글 표현에는 세 가지 방법이 존재하며, 글의 성격에 가장 적합한 방법을 선택할 수 있어야 합니다.
블로그는 주로 서술식이 많지만, 개조식과 도식은 실무, 협업에서 많이 쓰입니다.
- 서술식
- '~다'로 끝나는 완전한 문장
- 소설, 기사, 개발 가이드 등 무언가를 설명하거나 논증할 때 사용
- 개조식
- 명사, 명사형으로 끝나는 문장
- 신문 헤드라인, 릴리즈 문서, 장애 보고서 등 무언가를 나열할 때 사용
- 도식
- 구조나 관계를 그림이나 서식으로 표현
- 주로 표, 그래프 등을 사용
이유 있는 컨벤션
사실 이름 짓기는 수많은 개발자들의 평생 고민 중 하나입니다.
그러다 보니 컨벤션의 탄생 배경에는 수많은 고민의 흔적이 존재할 수밖에 없습니다.
가령, 코드의 네이밍 컨벤션은 영어 표기법을 많이 상속받았습니다.
클래스가 PascalCase인 것은 영어에서 명사는 대문자로 시작하기 때문입니다.
함수가 camelCase인 것은 명사가 아닌 것들은 소문자로 시작하기 때문입니다.
패키지와 모듈은 로직들을 담는 역할에 불과하므로 전부 소문자로 표현합니다.
컨벤션은 더 나은 가독성과 소통을 위한 고민의 흔적들이 모여 규약이 된 것입니다.
그러니 더 나은 협업을 위해서라도 컨벤션을 필수로 사용해야 합니다.
하지만 정답은 없습니다. 팀 내에서 가장 효율적인 방식을 택하는 것이 좋습니다.
저 술 편 집
기술 블로그의 글은 크게 4가지로 구분할 수 있습니다.
- 저 : 직접 경험하고 실험한 과정이나 결과 (개발기, 도입기, 적용기)
- 술 : 어떤 것을 분석하여 의미를 풀이하고 해석한 것 (기술 소개, 용어 분석, 에러 해결 방법)
- 편 : 복잡한 자료를 편집해 질서를 부여한 것 (프로그램 설치/설정 방법, 튜토리얼, 세미나 후기, 책 리뷰)
- 집 : 여러 견해나 흩어진 자료를 한데 모아 정리한 것 (명령어 모음, 팁, OO가지 규칙)
글쓰기 초기 단계에선 편, 집 유형의 포스팅을 시작하는 것이 좋습니다.
글을 쓰기도 쉬울뿐더러 조회수도 높아 동기를 부여하기 좋기 때문입니다.
글쓰기가 점차 숙달되면 저, 술 유형으로 나아가고자 노력합시다.
개발 경험을 쓰는 것은 무척 어렵지만 그만큼 개발자의 수준을 보여줄 수 있기 때문입니다.