[책리뷰] 개발자의 글쓰기

항상 네이밍에 어려움을 겪고 있던 터라 여니 씨가 추천해주자마자 잘됐다! 하고 읽게 되었다.

https://product.kyobobook.co.kr/detail/S000001766399

개발자의 글쓰기 | 김철수 - 교보문고

 

목차는 이렇다
▣ [프롤로그] 개발자의 글쓰기는 달라야 한다
▣ 1장: 개발자가 알아야 할 글쓰기 기본
▣ 2장: 개발 시간을 줄여주는 이름 짓기와 주석 쓰기
▣ 3장: 사용자와 소통하는 에러 메시지 쓰기
▣ 4장: 독자 관점에서 릴리스 문서와 장애 보고서 쓰기
▣ 5장: 설명, 묘사, 논증, 서사로 개발 가이드 쓰기
▣ 6장: 수주를 돕는 SI 제안서 쓰기
▣ 7장: 기술 블로그 쉽게 쓰고 운영하기
▣ [애필로그] 회사가 개발자 글쓰기 교육을 하자



내가 주니어 개발자라고 해서 이 책에서 얻을 거라고는 이름 짓기와 기술 블로그 쓰는 팁뿐이라고 생각했던 게 무색했다.
협업하는 법과 공식문서 읽는 법까지 배우게 되었다.

작가님이 역시 국문학을 전공하셔서 그런지.... 글쓰기 표현이 전문적이었고

20년이상 개발 일한 시니어 개발자라 설명에 예시가 적절해 이해하는 데 큰 도움이 되었다.

 

 

개발자 누구나 한번쯤 읽어보면 좋을 듯 하다.

글쓰기는 개발자들이 다른 사람들과 잘 협력하기 위해 필수 능력

---

⛳ 정리한 부분

개발자의 글쓰기 기본

• 정확성
• 간결성
• 가독성

네이밍 컨벤션

• 보통 16글자, 3 단어의 조합
• 명사/동사/형용사 + 명사 + 명사 조합으로 이루어짐
• 영어의 대문자 표기 원칙 적용
• 클래스명은 파스칼 표기법
• 함수, 변수명은 카멜 표기법
• 상수는 모두 대문자
• 패키지, 모듈은 모두 소문자

변수 이름 짓기

1. 구현해야 할 요구사항 나열
2. 함수 문장을 영어로 번역
3. 불필요한 단어 빼기

좋은 이름 특징 5가지 SMART

• easy to Search
• easy to Mix
• easy to Agree
• easy to Remember
• easy to Type

 

코드는 의미를, 주석은 의도를 나타낸다.

Semantic Versioning 유의적 버전

• Version 1.2.2 → 1.2.3 : 간단한 패치 (이전 버전과 호환)
• Version 1.2.2 → 1.3.0 : 새로운 기능 추가
• Version 1.2.2 → 2.0.0 : 전면 업그레이드

기술 블로그 목차 구조화

• 저 : 직접 경험하고 실험한 과정이나 결과 (개발기, 도입기)
• 술 : 어떤 것을 분석하여 의미를 풀이하고 해석한 것 (기술 소개, 에러 해결)
• 편 : 산만하고 복잡한 자료를 편집해 질서를 부여한 것 (튜토리얼 / 책 리뷰)
• 집 : 여러 사람의 견해나 흩어진 자료를 한데 모아 정리한 것 (명령어 모음 / 팁)

2022년 10월 공부함