고코딩

개발자를 위한 글쓰기 가이드 후기 본문

책 후기

개발자를 위한 글쓰기 가이드 후기

고코딩 2021. 10. 2. 15:13

개요

회사에서 프로젝트나, 에러를 해결하면 관련된 문서를 작성해야할 일이 많았다. 하지만 항상 글을 쓸때마다 첫 문장을 작성하는 것 부터가 힘들었다. 글을 다 쓰고 난 뒤에도 만족스러운 글이 나오지 않았고, 내 글쓰기에 문제가 많다는 것을 느꼈다.

또한 회사에 지정된 양식이 없어서 답답함이 많았다. 내가 못 찾는 것일 수도.. 마침 팀에내 한달에 한번 원하는 책을 읽고 독후감을 발표하는 일정이 생겨서 이 책을 읽었다.

image

그냥 읽어보면 좋은 책

책을 다 읽어본 후 든 내 생각은 "책 제목이 잘못되었는데?" 였다. "글쓰기 가이드"가 아니라 "글쓰기 꿀팁"이라고 바꿔야 한다고 생각이 든다.

책 내용이 글을 쓸때 유의해야할 단어나 문장, 어조, 쉽게 틀릴 수 있는 포인트들에 대해서 알려준다. 충분한 예시를 들면서 설명해주기 때문에 이해하기 쉬웠다. 평소에 생각하지도 못했던 포인트를 짚어주면서 어떻게 글을 써야 좋은 글을 쓸 수 있는지도 알게되었다. 하지만 가이드는 아니라고 생각한다.

처음 기대했던 내용은 기술 가이드 문서 작성 방법이나, 보편적으로 지켜야할 양식을 알려주는 내용을 기대했다. 내가 기대했던 내용과 왜 달랐던 것일까? 생각해 보면 회사마다 양식은 천차만별이다. 한마디로 양식 자체는 내가 만들어 가야한다. 이 때문에 지은이도 전체적인 양식에 대한 설명을 해주는 것이 아니라, 글쓰기를 하면서 얻었던 꿀팁들을 설명해주고 있다.


결국 많이 써봐야 한다.

글쓰기를 잘 하려면 결국에는 많이 작성해봐야 한다. 이 책을 한번 읽고 바로 완벽한 문서를 만드는 것은 불가능하다. 여러가지 양식을 시도해 보면서 글을 써봐야 실력이 오를 것이다. 이 책의 내용은 글을 쓰면서 표현이 애매할 때 한번씩 펼쳐보면서 참고하면 좋을 것 같다. 이 책에 있는 내용들이 100% 맞는 것은 아니다. 왜냐하면 디테일한 양식은 결국 회사의 구성원들의 의견을 종합해서 정하기 때문이다. 이 책은 글쓰기 기본기로 생각하고 한번쯤은 읽어보는 것을 추천한다.


어떤 사람이 읽으면 좋을까?

  • IT기업에 종사하는 모든 사람들
  • 첫 문장을 시작하기 어려워하는 개발자
  • 본인의 글이 마음에 들지않는 개발자
  • 영업팀(IT 용어를 정리해서 쓰는 방법을 알 수 있을 것이다.)