변수명, 클래스명, 메서드명과 더불어 기술 블로그 작성 길잡이가 필요하시다면!

왜 읽게 되었나요?

우테코 프리코스를 진행하며 변수명과 메서드명으로 명확한 코드 구조를 알리고 싶었으나 그렇지 못 했어요.
코드 리뷰를 통해 부족함을 느꼈습니다.
'앞으로는 옳은 네이밍으로 가독성 넘치는 코드를 작성하고 싶어!'라는 생각에 읽게 되었어요.

어떤 책인가요?

네이밍, 주석 작성법에 이어 에러 메시지를 어떻게 다루어야 하는가, 독자 입장에서의 좋은 문서를 만드는 방법은 무엇인가, 기술 블로그는 어떻게 작성해야 하는가 등을 다루는 책이에요.

누구에게 추천하나요?

저처럼 네이밍에 대해 고민을 갖고 계시거나 회사 내에서 각종 문서를 작성하시는 분, 기술 블로그에 어떤 글을 써야 할 지 헷갈리시는 분들이 읽으시면 좋을 것 같아요!

어떤 것을 배울 수 있나요?

변수명, 메서드명에 대한 기준을 잡을 수 있었어요.
독자 입장에서 어떠한 글을 써야 하는지를 깊게 고민해볼 수 있었어요. 특히 '수주를 돕는 SI 제안서 쓰기'라는 챕터가 있는데, 학부연구생으로 과제를 얻기 위해 문서를 작성했던 시절이 떠올랐어요.
당시에는 '왜 이렇게 써야 하지?' 혹은 '이런 방향성으로 작성하는 게 더 낫지 않나?'같은 생각이 있었는데, 당시에 이 책을 읽었더라면 더 나은 문서를 작성할 수 있었을 것 같아요.

무엇을 느꼈나요?

앞으로는 더 명확하게 네이밍을 할 수 있을 것 같아요. 물론 연습이 필요하겠지만요..!
이전까지는 글쓰기가 굉장히 무겁게만 느껴졌고, 그에 비해 글은 가벼웠다고 생각해요.
앞으로는 가벼운 글에 가볍지만은 않은 글을 작성하고 싶습니다!

여담이지만, 정말 좋은 책이라 느껴져서 이렇게 정리도 해놨어요.
저작권 때문에 공개할 수는 없지만.. 정말 꼭 한번 읽어보셨으면 좋겠어요!