개발자는 글을 못 쓴다고요?

<개발자는 글을 못 쓴다고요?> 후기 개발을 하면서 커밋 메시지부터 시작해서 리드미나 장애보고서 등등, 남들에게 글을 써서 공유하는 케이스가 많다.

나는 책을 읽을 때 ‘저자의 말’이나 ‘여는 글’을 항상 읽는데, 저자가 책이나 글쓰기에 대한 본인의 주관이 뚜렸하고 공감되는 말이 많아서 놀라웠다.

특히 책 내용 중에 개발자가 글을 못쓰는게 아니라, 여러 번 검토하지않고 남에게도 보여주지 않아서 못써보이는 것이라는 것에 큰 공감을 했다.

회사에서 개발 업무를 할 때 높은 확률로 협업을 하게 된다. 협업을 하는 상대방이나 다른 조직이, 개발한 프로덕트의 상황과 히스토리를 잘 알게하시 위해서는 문서화된 설명이 필요하고, 이는 릴리즈노트, 리드미, 아키텍처 문서, 코드 내 주석, 커밋 메시지 등으로 작성이 가능하다.

여태 불필요하고 마이너하다고 생각했던 항목인데, 돌이켜보니 중요했던 부분이었고 조금만 관심을 가지면 꽤 높은 퍼포먼스를 낼 수 있다고 생각한다. 이러한 스킬은 비단 개발 뿐만이 아니라 본인의 전반적인 업무 능력을 향상 시킨다고 생각한다.

특히 책을 읽는 기간 중, 회사에서 서비스 장애가 발생하여 장애 보고서를 쓸 일이 있었는데 본 책을 참고하여 작성하였다.

GPT가 만들어준 장애 리포트 템플릿을 바탕으로, 장황하게 보고서를 작성하다가, 해당 책을 찾아보니 장애 리포트를 쓰는 방법이 명확하게 기술되어있어서 참고를 많이했다.

특히 “~하는 것이 좋다.”의 어투가 아니라, “~하세요.”의 단호한 말투는 마치 멘토가 옆에서 지도해준다는 느낌을 받았다.

테크니컬라이팅은 어렵다. 기술 블로그를 운영하기도 어렵고, 사내 기술 레포트를 작성하는 것도 어렵다. 하지만 이 책을 읽고 내가 여러 시도를 하지 않아서 그렇게 느껴졌다는 것을 뒤늦게 알았다.