서평: 개발자를 위한 글쓰기 가이드

이 책을 읽게 된 이유

요즘 출장이 잦아지면서 기차에서 읽을 가벼운 책을 찾기위해 이것저것 뒤적거려보던 중 우연히 발견한 책.

PM 직무를 맡으면서 프로젝트 기획서, 기능 설계서, 사용자 가이드 등 다양한 문서를 작성하게 되었는데 매번 문서를 작성할 때마다 좀 더 체계적으로 적을 수 있었으면 좋겠다는 생각을 했습니다.
물론 경험을 쌓는 과정에서 점점 나아지긴 했지만… 항상 뭔가 아쉬움이 있었습니다.

이런 주제를 다루는 책은 의외로 잘 없는 편이라서 가벼운 마음으로 한번 읽어 보자는 생각으로 구매하게 되었습니다.

책 소개

도서명: 개발자를 위한 글쓰기 가이드 – 예제로 배우는 테크니컬 라이팅 핵심 비법
저자(글): 유영경 지음
출판사: 로드북
발행(출시)일자: 2021년 2월 26일
쪽수: 287쪽
가격: 12,800원

구성 및 주제

총 3부로 구성되어있으며 각 부(part)에는 장(chapter)과 절이 있는데, 각 절은 핵심 내용과 예시를 한두 페이지로 구성해 필요한 부분만 그때그때 쉽게 참고할 수 있게 되어있습니다.

글의 흐름

1부에서는 테크니컬 라이팅과 기술 문서가 무엇이고, 글을 쓸 때 먼저 고려해야 할 점이 무엇인지 알아보고,
2부에서는 기술 문서를 쓸 때 일반적으로 지켜야 할 테크니컬 라이팅 원칙을 살와 함께 알려줍니다.
3부에서는 메일, 회의록, 확인 메시지, 사용자 가이드 등 문서 유형에 따라 고려해야 할 작성 원칙을 안내합니다.

인상 깊은 내용

이 책을 통해 처음으로 ‘테크니컬 라이팅’과 ‘테크니컬 라이터’라는 용어를 접하게 되었습니다.
이를 통해 글쓰기에 대한 새로운 시각을 얻을 수 있었습니다.
(※ 테크니컬 라이팅: 기술이나 과학 분야에서 정보를 정확하게 전달하기 위한 글쓰기)

2부에서는 테크니컬 라이팅의 원칙 45가지를 하나씩 예시를 들어가며 설명해줍니다.
이러한 구성은 한 번 정독한 후, 다음에 글을 쓸 때 목차만 한번 훑어봐도 많은 도움이 될 것으로 기대됩니다.
문서를 검토할 때 체크할 내용을 담은 표도 유용하게 사용될 수 있을 것으로 보입니다.

평소에 쉽게 접할 수 있었지만 실제로 글을 쓸 때는 대부분 작성하지 않는 ‘개념과 목적을 설명하는 개요’에 대한 내용도 책에서 다루고 있었는데 제대로 인식을 하고나니 앞으로 글을 쓸 때 꽤 도움이 될거 같습니다.

기술 문서에서 자주 실수하는 외래어 표현을 알려주는 파트가 있었는데, 대부분 알고있는거긴 한데 ‘솔루션’의 올바른 표현이 ‘설루션’이라는것은 충격…. 이건 알아도 표준으로 못쓸거 같네요.

평가 및 추천 여부

추가 정보

공식 도서 정보 및 샘플 파일 : https://roadbook.co.kr/246