[Book] 개발자의 글쓰기

 

 

개발을 하다보면 드는 고민이 있다.

이상하게 알고리즘 적으로 이야기하고, 이야기의 논지가 중요하며

원인과 결과를 따지고 있다.

 

대부분의 개발자는 글과 거리감이 있기에

자연스레 글과는 멀어져 있다.

 

하지만 개발자에게 변수네이밍과 협업이 중요하다는 것은

굳이 강조하지 않아도 다 아는 사실.

 

이번에 읽어 본 책 개발자의 글쓰기는 제목에 매우 충실할 정도로

개발자에게 도움이 된다. 개발자가 아니라면 추천하지는 않는다.

 

무엇보다 기억에 남는 부분은 변수이름을 짓는 것이 가장 기억에 남았고,

개발자의 측면이 아닌 비지니스나 소비자의 시선에서 바라보고

글을 어떻게 쓰면 좋은지 가이드 해준다.

 

변수 네이밍은 외래어를 잘 구분해서 사용하고,

비슷한 언어가 많으니 혼동하지 않는게 좋으며,

기본적으로 자바 네이밍 컨베션을 철저히 준수한다고 하는데,

어디서 한번쯤은 본적이 있는 형식이다.

 

클래스는 UpperCamelCase

함수와 변수는 lowerCamelCase

상수는 UPPER_DELIMITER_CASE

패키지와 모듈은 모두 소문자

 

이렇게 작성하면 좋고, 널리 알려진 약속이라고 한다.

(실제로 나도 누군가인지 모른 선배 개발자에게 듣고 실천 중이였다.

가끔 클래스와 함수나 변수는 혼동해서 쓰지만...)

 

이러한 내용 말고도 

블로그는 어떻게 써야하는지,보고서, 제안서는 어떻게 써야하는지 등이 있다.

 

알라딘 중고 서점에서 충동 구매한 것 치고는 매우 만족스러운 책이였다.

 

 

 

메모 한줄

• 주석도 코드다.
• 사용자를 이해하면 에러를 예방할 수 있다.
• 문제, 문제점, 해결책, 후속 계획 순으로 적자.
• 원인과 이류를 찾는 방법에는 5why?를 사용해볼 수 있다.
• 이유를 물어 볼 때는 항상 사람이 주어가 돼어야 한다.
• 에러 재발가능성을 %로 표현해보자.
• 글을 쓰기전에 고민해야할 것들
  • 이 글을 왜 쓰는가?
  • 이 글을 읽는 독자는 누구인가?
  • 이 글을 읽는 독자에게 무엇을 말하려고 하는가?
  • 이 글이 중장하는 바가 무엇인가?
  • 이 글이 주장하는 바의 근거는 분명한가?
• 기술적 블로그 작성을 위한 참고 추천 목록
  • 네이버 기술 블로그 (https://d2.naver.com/home)
  • 우아한형제들 기술 블로그