brunch

You can make anything
by writing

C.S.Lewis

by gnugeun May 24. 2023

개발자를 위한 글쓰기 관련 책들

 무라카미 하루키는 <달리기를 말할 때 내가 하고 싶은 이야기>라는 책에서 '소설가로서 가장 중요한 자질은 무엇입니까?'라는 질문에 '말할 나위도 없이 재능'이라고 답했다. 확실히 소설을 쓸 때는 재능이 가장 중요할 것이다. 하지만 업무 중 쓰는 논리적인 글은 재능보다는 노력의 비중이 더 크다고 생각한다. 논리적인 글에서는 독자에게 무엇인가를 전달하기 위해 인물이나 상황을 자신만의 문체로 새롭게 창조할 필요가 없기 때문이다. 이런 종류의 글은 시간과 에너지를 투자하면 반드시 더 나은 결과가 나오게 돼 있다.

 다만 글을 더 잘 쓰려고 노력하는 과정이 꽤나 고통스러울 수는 있는데 그 과정을 조금 더 쉽고 빠르게 진행할 수 있도록 도와주는 책들이 바로 글쓰기 관련 책들이다. 이번 글에서는 내가 읽고 나서 많은 도움을 받았던 글쓰기 관련 책 네 권을 소개하려고 한다. 

 먼저 소개할 두 책은 글 자체에 중점을 두고 글을 논리적으로 쓰고 간결하게 다듬는 법을 알려주는 책으로 <유시민의 글쓰기 특강>과 <내 문장이 그렇게 이상한가요?>이다. 두 번째는 개발자가 주로 다루는 문서 예제와 함께 개발에 특화된 글쓰기 방법을 알려주는 책으로 <개발자를 위한 글쓰기 가이드>와 <Docs for Developers>이다. 


유시민의 글쓰기 특강

 가장 먼저 소개하고 싶은 책은 <유시민의 글쓰기 특강>이다. 저자 이름만 듣고 바로 거를 사람이 많을 것이라고 생각하는데 유시민이라는 사람을 걷어내고 보면 논리적인 글쓰기라는 관점에서는 가히 최고의 책이라고 생각한다. 읽어보면 알겠지만 저자가 유시민인 것 치고는 정치적 색채도 옅은 편이다(물론 저자가 유시민인 것 치고 그렇다는 것이지 아예 없지는 않은데 예를 들어 못 쓴 글의 예시로 보수 정치인들의 글이 등장한다). 

 이 책을 읽고 나서 책에서 배운 내용을 적용해 보려고 노력하면서 글을 쓴 뒤 그전에 쓴 글과 비교해 봤는데 그전에 쓴 글을 모두 지우고 싶어졌다. 비단 글쓰기뿐 아니라 논리적으로 생각하는 법까지 배울 수 있는 책이다. 

https://product.kyobobook.co.kr/detail/S000001015900?LINK=NVB&NaPm=ct%3Dlhrm1zqg%7Cci%3De962c5a20a46a2369c9769e89d5c5ac1195cae50%7Ctr%3Dboksl1%7Csn%3D5342564%7Chk%3D29d63681f78cb560b460976b56d66085922bcc44


내 문장이 그렇게 이상한가요?

 다음으로 소개할 책은 이정선의 <내 문장이 그렇게 이상한가요>이다. 문장 다듬기의 달인인 교정 교열 현직자가 자기 경험을 바탕으로 조금 더 문장을 자연스럽게 쓰는 방법을 다양한 예시와 함께 풀어낸 책이다. <유시민의 글쓰기 특강>보다 조금 더 글쓰기 기술에 집중한 책이라고 할 수 있겠다. 

 완전 글쓰기 초보보다는 어느 정도 글쓰기에 익숙해진 뒤 한 발 더 나아가 문장을 유려하게 다듬고 싶은 사람이 보면 좋을 것 같다(초보라면 <유시민의 글쓰기 특강>을 먼저 읽어야 한다). 

https://product.kyobobook.co.kr/detail/S000001863138


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

 이 책은 Microsoft와 NAVER, NHN을 거쳐 현재는 배달의민족 앱으로 유명한 우아한형제들에서 테크니컬 라이터로 일하고 계신 유영경 님이 쓴 책이다. 앞서 소개한 두 책이 오로지 글의 관점에서 글쓰기를 다룬다면 이 책은 보다 개발 업무에 특화된 글쓰기 방법을 소개한다. 예를 들어 표나 스크린숏, 차트와 같은 시각화 요소를 언제 어떻게 사용하면 가독성을 높일 수 있는지와 같은 내용도 나온다. 

 책의 전반부는 앞서 소개한 두 책에서 기술 문서에 해당하는 부분만 뽑아내 요약한 발췌 요약본이라고 생각하면 된다. 글쓰기 기초를 다지는 부분이다. 기초를 다진 뒤에는 실전 연습에 들어간다. 메일과 회의록, 오류 메시지, 장애 발생 공지문, 사용자 가이드 작성 방법을 실제 기업에서 작성해 사용자에게 공지했던 사례와 함께 차근차근 배울 수 있다. 

 이 책은 내용뿐 아니라 글 자체의 완성도도 매우 높다. 그야말로 술술 읽힌다. 앞서 소개한 두 책을 읽을 시간이 없는 개발자라면 이 책을 강력 추천한다. 책을 읽으면서 내용뿐 아니라 읽는 문장 자체에서도 배울 점이 많은 흔치 않은 기술 서적이다. 

https://product.kyobobook.co.kr/detail/S000001624711

 다만 아쉽게도 읽으면서 몇 군데 오탈자를 발견해서 기록을 남긴다.

 첫 번째는 107페이지 마지막 문단 첫 번째 문장으로 마지막에 '다'가 한 번 더 들어갔다. 

 두 번째는 각주 번호가 맞지 않게 표시된 부분이다. 먼저 아래 187페이지를 보면 '최댓값' 각주 번호가 본문에는 2번이라고 돼 있는데 실제 각주에서는 4번으로 돼 있다. 아래 '사용률' 역시 2번이라고 돼 있는데 사용률 각주는 아예 누락된 듯하다.  


187페이지에서 벌어진 각주 번호 문제는 194페이지와 195페이지에까지 영향을 끼친다. '사용 중'과 '다시 한번', '나길동님'의 각주 번호가 밀린 것을 확인할 수 있다.

 좋은 책이니만큼 다음 버전에서는 꼭 수정돼 출판되면 좋겠다. 


Docs for Developers

 다음은 자레드 바티, 재커리 사라 콜라이센, 젠 램본, 데이비드 누네즈, 하이디 워터하우스가 쓰고 하성창 님이 번역한 <Docs for Developers>라는 책이다. <개발자를 위한 글쓰기 가이드>가 글쓰기 초보 개발자가 전반적으로 글쓰기 실력을 높이고 싶을 때 읽을 만한 책이라면, 이 책은 글쓰기에 이미 익숙한 개발자 혹은 테크니컬 라이터가 어떤 서비스를 문서화하는 작업의 일부 혹은 전체를 맡았을 때 참고하기 좋은 책이다. 

  <개발자를 위한 글쓰기 가이드>가 메일과 회의록, 오류 메시지, 장애 발생 공지문, 사용자 가이드와 같은 예제를 각각 개별 사례로 단편적으로 다룬다면, 이 책은 서비스 출시 과정에서 작성하는 모든 문서를 작성하는 순서에 따라 체계적으로 연결해서 다룬다. 문서 작성뿐 아니라 문서 배포와 피드백 수집, 품질 측정, 문서 구조화, 유지 관리 및 지원 중단 방법까지 다룬다. 글쓰기 자체에 대한 내용은 거의 없고, 서비스를 개발하고 출시하는 과정에서 문제가 발생하거나 니즈가 생겼을 때 어떤 종류의 문서를 누구와 협업해서 어떤 방식과 형식으로 작성해서 배포하고 관리하면 좋은지를 주로 알려준다. 

 특이한 점은 마치 소설 같은 구성이라는 점이다. 가상의 주인공을 등장시켜서 그 주인공이 어떤 IT 서비스의 문서화 작업을 맡아 진행해 나가는 이야기를 따라가며 문서 작성 방법을 설명하는데 괜찮은 방식이라고 생각했다.

https://product.kyobobook.co.kr/detail/S000201419245


 글쓰기 실력을 높이고 기술 문서 작성 방법을 배우고 싶어 책을 찾고 있던 사람들에게 도움이 되길 바라며 마치겠다.

매거진의 이전글 프로테스탄트 윤리와 자본주의 정신, 독서록
브런치는 최신 브라우저에 최적화 되어있습니다. IE chrome safari