[책 리뷰] 개발자의 글쓰기 - 개발자가 되고 싶고 글쓰기도 잘하고 싶어

개발자의 글쓰기(지은이: 김철수)

 

velog 탐방 중에 https://velog.io/@frozing/2021-개발자-필독서-55권-2 포스팅을 보고 읽고 싶은 책을 알라딘에 한 바가지 추가해뒀다. 이 책은 그중에 유일하게! 학교 전자도서관에 대출 가능한 책이었다. 사실 이 책을 읽고 싶었던 이유 중에 8할은 기술 블로그이다. 물론 현재 내 블로그는 지식을 공유하는 기술 블로그라기엔 턱없이 부족하고, 배운 것을 정리하고자 하는 목적이 크다. 하지만 허접해 보이는 지금 내 글들도 나름의 고민을 해가며 작성하기 때문에, 이 책을 통해 글 작성에 도움을 받고 싶었다. 그럼 앞으로의 공부에 더더더 도움이 되지 않을까? ㅎㅎ

 

 

 

개발자는 글을 못 쓴다?

작년 기초 DB 수업 때 교수님이 하셨던 말씀이 생각나는 구절이다. 그때 교수님이 DB 설계에 있어서 중요한 요소 중 하나가 바로 커뮤니케이션이라고 했다. 커뮤니케이션을 통해 고객의 요구사항을 제대로 끌어낼 수 있어야 이를 만족시키는 결과물을 낼 수 있다는 것이다. (물론 이 뒤에, 컴공과 학생들이 커뮤니케이션 능력이 조금 떨어지는 것 같다는 말도 하셨다ㅎㅎ..) 이 말을 듣고 굉장히 공감했었는데, 어찌 보면 글도 하나의 커뮤니케이션 수단이라고 생각한다. 고객과 요구사항, 제안서 등을 문서로 주고받을 수 있고, 다른 개발자가 주석, 오류 메시지 등을 읽고 이해해야 하는 상황이 올 수도 있다. 이런 상황에서 글을 잘 쓰는 개발자라는 것은 커뮤니케이션 능력이 뛰어난 개발자라고 생각한다. 

 

책에서 소개한 개발자의 글쓰기의 핵심!!!! 항상 가슴에 새기고 글을 써야겠다. 

• 정확성: 틀림이 없이 확실한 것
• 간결성: 글에 군더더기가 없고 간단하고 깔끔한 것
• 가독성: 쉽게 읽히는 것

 

 

이름 짓기가 제일 어렵다!

깃허브 인기 자바 소스를 분석해 네이밍 컨벤션에 대해 연구한 글 "오픈소스의 네이밍 특징들"의 결과와 그 이유에 대해서 설명했다. 컨벤션의 의미처럼 그냥 관례다 생각하고 별생각 없이 써왔는데, 이게 영어 표기법을 따른 것이었다니!!

 

책에서 나온 좋은 이름이 가진 5가지 특성 (easy to) Search, Mix, Agree, Remember, Type 통칭 SMART를 잘 기억하며 이름을 잘 지어야겠다. 간단한 알고리즘 문제를 풀 때도 주석을 주렁주렁 다는 습관이 있는데, 이름을 잘 지으면 주석을 줄일 수 있다는 문장을 보고 반성하게 되었다. 코드에는 의미를, 주석에는 의도를 담으라는 말처럼, 그 의미를 충분히 이해할 수 있도록 코드를 짜야겠다. 또한 내 의도를 충분히 설명해줄 수 있는 주석을 다는 연습을 하자!!😎

 

 

개발자도 자신만의 철학을 가져야 한다

내가 이 책을 지금 읽어서 이해하고 배울 수 있는 내용은 네이밍 컨벤션이나 기술 블로그뿐일 것이라 생각했다. 그런데 의외로 에러 메시지나 장애 보고서 작성법에서도 많은 것을 느꼈다. 특히 에러 메시지와 관련한 다음 내용이 인상 깊었다. 

 

이것은 결국 철학의 문제다. 개발자가 사용자를 불완전한 존재로 인식하는 순간 모든 사용자의 행동에 경고로 대응한다. 그러면 시스템도 불완전해진다. 사용자의 행동 하나하나가 불완전하므로 사용자의 모든 행동을 검증해야 한다. 사용자를 성인이 아니라 미숙아로 취급하는 것과 다름없다. 

 

개발자가 사용자를 어떻게 바라보아야 하는지, 내 개발자로서의 철학은 무엇인지에 대해 고민해보게 되었다. 전에 우아한 형제들 김범준 대표님께서 인터뷰에서 "개발자는 코딩하는 사람이 아니라, 비즈니스 문제를 해결하는 사람"이라고 얘기하는 것을 봤다. 이 말을 듣고, 당장의 필요한 기능 구현에 국한되지 말고 그 기능이 왜 필요한지, 비즈니스에 어떤 영향을 미치는지 등을 생각하자고 다짐(?)했다. 그러려면 개발을 하면서도 능동적으로 생각하는 자세가 필요하고, 이를 위해 내 개발자로서의 철학을 키워나가야겠다고 생각했다. 

 

 

멋진 블로거가 될래요👩‍💻

1. 주제 의식을 버리고 소재 의식으로 쓰자
2. 독자 수준이 아니라 자기 수준으로 쓰자
3. 재미있게 글을 쓰자

이 책에서 소개한 기술 블로그 잘 쓰는 방법 중에 특히 2, 3번이 와닿았다. 다른 사람들의 블로그를 보다 보면 아주 깔끔하게 글을 잘 썼다고 느낄만한 글들이 많다. 나는 항상 그런 글들을 보고 난 후, 다음 포스팅에 그 글의 구성을 흉내 냈던 것 같다. 물론 가독성을 위해 깔끔한 글의 구성을 참고할 수 있다. 하지만 나처럼 배운 것을 정리하는 차원에서 글을 쓴다면, "자신의 언어"로 글을 쓰는 게 가장 좋을 것이다. 잘 모르는 내용을 있어 보이게 쓴다거나, 어려운 단어를 굳이 고집해서 쓸 필요가 전혀 없다는 것이다. (말은 잘하지만 나는 아직 "자신의 언어"가 뭔지 잘 모르겠다..!ㅠ) 앞으로 블로그 글을 작성할 때도, 누군가 본다는 부담은 조금 내려놓고(물론 아무도 안 보면 슬플 것이다) 나만의 언어로 우선은 내가 잘 이해할 수 있는 글쓰기를 연습해야겠다. 

 

 

 

글쓰기 책을 읽고 리뷰를 쓴다는 것은 많이 부담스러운 일인 것 같다.😅 내가 글을 못 쓴 건 내 탓이지 이 책이 부족한 게 절대 아님을 잘 알아주면 좋겠다.

이 책은 개발자가 글을 써야 하는 상황에 대해 폭넓게 다루고 있으므로 말 그대로 "글을 잘 쓰고 싶은 개발자"들에게 추천한다. 책을 매우 오랜만에 읽은 나도 쉽게 읽을 수 있을 만큼 잘 이해시킨다(?)는 느낌이 강한 책이다.