[개발/코딩/프로그래밍] 개발자의 글쓰기

이번 코로나 사태가 터지기 직전에 가까스로 회사에 입사할 수 있었다.

입사한 회사에서 내가 맡게 된 업무는 시뮬레이션 환경 구축이다.

 

대학교, 대학원 시절에도 다양한 시뮬레이션 환경을 구축해봤는데, 대부분 일회성 혹은 단기적으로 이용할 환경이어서 유지보수 보다는 기능 구현에 충실했었다.

 

시뮬레이션 환경 구축을 하면서, 내가 구축한 환경을 다른 "많은" 사람들도 불편함이 없이 써야한다는 고민을 회사에 와서 거의 처음해봤다.

 

이런 고민을 안고 개발한 환경의 코드를 보니 다른 사람들이 이용하기엔 너무 별로인 것 같아서 어떻게 하면 좋은 코드를 짤 수 있을지 고민하다 이 책을 찾게 되었다.

 

http://www.kyobobook.co.kr/product/detailViewKor.laf?ejkGb=KOR&barcode=9791158391744

개발자의 글쓰기 - 교보문고

 

때마침 공부하고 있는 여러 내용들도 정리하려고 블로그를 살릴 생각을 하고 있었는데, 일반적인 글은 잘 쓸 수 있겠지만 개발자 입장에서의 글은 어떻게 써야할지 도무지 감이 안잡혀서 쓰지 않고 있었다.

다른 책을 보면서 만들어둔 내 깃허브 블로그(https://sunandbean.github.io/)가 나름 개발자로 쓸거라고 만들어 둔건데 여기도 그냥 공부하면서 작성했던 코드랑 느낀 점 정도를 굉장히 날 것으로 써놔서 막막했다.

 

그래서 오랜만에 내 돈주고 종이책을 샀다!

 

무튼 이 책의 저자는 나와 동문이다! 한양대 국문과를 졸업하셨다고 한다. 개발자가 아닌 사람이 개발자의 글쓰기를 썼다는게 처음엔 의아했지만, "글쓰기"라서 국문과 분이 쓰신 것 같기도 했다.

 

후기를 쓰려다보니 따로 정리해두거나 괜찮다는 문장을 체크해둔게 없는데 다음부터는 좀 체크해둬야겠다.

 

결국 이 책을 관통하는 내용은 '개발자들끼리 의사소통을 하기 위해서는 어떻게 글을 쓸 것인가' 와 '개발자가 쓰는 글과 고객이 원하는 글의 괴리를 어떻게 하면 줄일 수 있는가'라고 나는 생각한다.

 

개발자들끼리 서로의 코드를 보고 협업하기 위해서는 어떤 식으로 코드를 작성하면 좋을지에 대한 내용을 보면서, 내가 지금까지 코딩을 하면서 규칙성 없이 변수를 선언했던 방식들을 돌이켜볼 수 있었고, 특히 주석이 많다고 꼭 좋은 코드가 아니라는 말이 나에게 너무 와닿았다. 나는 일단 내가 이해한대로 코드를 작성하고, 사람들이 그거 보고 이해하기 어려우니까 주석을 줄줄이 달곤 했는데, 애초에 사람들이 이해하기 쉽게 코드를 짜면 모든게 해결되는 것이었다.

앞으로는 더 생각하면서 코드를 짜야겠다.

 

다음으로 환경 구축을 하면서 고민하던 버전관리에 대한 내용도 나와있었다. 릴리즈 노트와 관련해서 어떤 정보들을 버전관리를 하면서 담아내면 좋을지에 대해서 알 수 있었다. 만약 내가 구축하는 환경을 배포해야한다면 버전은 어떤 식으로 처리할 것이며, 반영한 변경 사항들을 어떻게 릴리스 노트에 담아낼 것인지 알 수 있었다.

 

그리고 마지막으로 기술 블로그는 어떻게 써야하는지 보면서 내가 하려는 블로그를 어떻게 꾸며나갈 것인지에 대해서도 생각해볼 수 있었다.

 

요즘 느끼는데, 이런 정보성 책들은 그냥 한 번 읽고 끝내는 용도가 아닌 것 같다. 한 번 책을 쭉 읽어보면서 나에게 필요한 내용이 어디에 있는지 체크해두고, 실제로 그런 내용이 필요한 시점에 다시 한 번 꺼내서 참고하는 용도로 쓰는 책 같다.

 

길면 길고 짧다면 짧은 약 270쪽의 책이지만 작가님의 필력이 좋아서 그런지 술술 잘 읽혔다. 그리고 내가 필요하던 부분들도 어느정도 커버할 수 있어서 다음에 필요하면 다시 한 번 꺼내서 읽어봐야겠다.