책리뷰 | 개발자의 글쓰기
11 Apr 2022 | Book개발자의 글쓰기
💫 Summary
한줄평 : 개발자가 작성하는 글을 다양한 예시와 함께 설명해주는 책
평점: ⭐⭐⭐⭐
글은 그 종류에 따라 글쓰기 방식이 달라진다. 우리가 흔히 알고 있는 좋은 글쓰기란 기-승-전-결이 완벽한 글이다. 하지만, 개발자가 가장 마주하는 글인 코드(code)로 대입해 봤을 때 기승전결이 완벽한 코드? 어딘가 묘하게 초점이 다른것 같다. 그렇다면 개발자로서 좋은 글을 쓴다는 것은 어떤 방법을 따르는 걸까.
개발자의 글쓰기 라는 책은 이 방법에 대해 작은 단위인 변수명 짓기부터 큰 단위인 보고서 작성까지 단계적으로 설명해준다. 책을 읽으면서 인상 깊게 보았던 부분을 두 가지 정도 추려 가볍게 이야기 해나가려고 한다.
- 좋은 변수명 짓기
- 릴리스 문서와 장애 보고서 쓰기
✨ 좋은 변수명 짓기
코드를 작성하기 전 변수나 메소드 혹은 함수 이름 등을 선언하고 시작한다. 이름을 짓는 가장 빠른 방법은 그 이름을 영어 단어로 번역하는 방법이라고 생각한다. 성적이면 var grade 이런 식으로. 하지만, 코드가 점점 더 복잡하고 길어질수록 이렇게 간단한 영단어로는 그 의미를 포함하는 게 어려워진다.
내가 생각한 좋은 변수명은 최대한 짧은 변수명이라고 생각했다. 아니, 어떻게 보면 좋은 변수명을 만들어야지 하는 고민을 해본 적이 있던가? 그저 단어를 파스칼 혹은 카멜식으로 작성하는 것을 지켰을 뿐이다. 그럼 좋은 변수명이란 뭘까.
저자는 좋은 변수명이란, 개발자 혹은 기획자가 보아도 이해할 수 있는 것이며 즉, 주석이 필요하지 않은 변수명이라고 설명한다. 무작정 줄이는 변수명이 아닌, 검색과 이해를 용이하도록 짓는 방법에 대한 것이었다.
그렇다면 이해 가능한 변수명은 어떤 기준을 따르고 있을까. 저자는 좋은 이름이 가진 5가지 특징인 ‘SMART’ 를 다양한 예시와 함께 설명해 준다.
- easy to Search
- easy to Mix
- easy to Agree
- easy to Remember
- easy to Type
✨ 릴리스 문서와 장애 보고서 쓰기
릴리스 노트에서 자주 보는 것은 역시 어플 업데이트 내역이라고 생각한다.
내가 보았던 릴리스 노트 중 가장 인상 깊었던 것은 이것이다. 대체 어떤 버그가 고쳐지고, 성능이 개선되었는지는 모르겠지만, 확실한 건 개발자가 오후 반차를 썼다는 것이겠지…
책에서는 가볍게 어떤 버그를 고쳤는지, 그리고 어떤 성능이 개선되었는지를 통합해서 정리하는 방법에 대해서 설명해 준다. 예시를 제시하여 공통적인 문장을 하나로 줄이고, 그로 인해 얻을 수 있는 성능 효과를 파악하는 등의 꽤 단계적인 방법을 통해 독자를 차근차근 이끌어준다. 나는 이 과정을 읽으면서 저자가 효과적으로 요약하는 방법을 알려준다고 느꼈다.
💫 마치며…
한 번 읽고 덮을 책이 아닌 주기적으로 펴볼 수 있는 책이라고 생각한다. 아직 SI 제안서, 개발 가이드 등은 작성할 일이 없기 때문에 가볍게 훑고 지나가는 느낌으로 읽었는데. 만약 이들을 작성할 일이 생긴다면 주저 없이 이 책을 펴서 도움을 받을 수 있을 것이다.
Comments