생각한대로 말할 수 없어 답답했던 <개발자를 위한 생각의 정리, 문서작성법>

생각한 대로 말할 수 없어 답답했던 개발자를 위한 생각의 정리, 문서 작성법 - 체계적인 정보 정리부터, 보고서·기획서·설명서의 구체적인 작성법과 테크니컬 라이팅까지
카이마이 미즈히로 지음, 안동현 옮김 / 프리렉 / 2024년 5월

   가독성이 좋고 이해력을 높일 수 있는 글쓰기는 정말 효과적이고 유용하다. 책을 읽다 보면 에세이라는 책도 편집이 어렵고 내용이 어려운 책도 있고, 전문서적에 가까운 책이지만 가독성이 좋고 이해하기 정말 쉬운 책들이 있다. '개발자를 위한 생각의 정리, 문서 작성법'이라는 책도 보고서나 계획서, 기안서만이 아니라 일반책들의 구성에 대해서도 생각해 볼 기회가 되었다.

예전 컴퓨터 활용인구가 적었을 떼 계획서와 보고서를 원고만 있으면 대신 작성하여 준 적이 있다. 계획서나 보고서는 짜여진 틀이 있어서 그것을 읽고 내용을 정리하기 정말 쉽다. 공문서도 전달하고자 하는 내용을 일정한 프레임에 맞춰 작성하기에 요점을 파악하기도 정말 쉽고 전달된 수행내용을 일목요연하게 이해할 수 있어서 내용을 파악하고 전달하기 정말 쉽다. 물론 그런 시스템으 활용하는 환경에 적응이 되어야 겠지만 적응만 되면 전달과 내용의 이해가 쉽다.

이 책은 주로 보고, 연락, 상담에 어려움을 겪는 젊은 IT개발자를 위해서 썼습니다.

이 책을 통해 아무도 가르쳐 주지 않는 사고(정보) 정리기술을 알고 커뮤니케이션에 대한

거부감을 해소하는 사람이 한 명이라도 늘어나길 바랍니다.

6쪽

문제를 해결하는 능력을 갖추고 있지만 상대방에게 전달하는 능력이 부족하고, 이해를 위해서 내용을 정리하는 방법이 부족할 수 있는 개발자들을 위한 실용서이다. 전달을 쉽게하기 위한 정보의 정리기술을 읽혀서 서로간에 소통의 원할함을 제공하기 위한 책이다. 일반적인 문서가 아닌 정보의 핵심을 전달하기 위한 방법을 기술한 책이고, 요약하고 압축하는 기술을 알려주는 책이기도 하다. 내용을 정리하기 위한 다양한 방법을 알려준다. 컴퓨터 자격증 수험생활을 하거나 프로그램을 짜는등 순서도에 대한 일반적인 개념이 있다면 내용을 접근법이 쉬울 수도 있을 것이다.

책을 통해 무엇을 알게 도움을 줄 수 있는지 명확하게 제공한다.(7쪽)

1. 잘못 작성된 문서가 어떤 것인질ㄹ 파악할 수 있어 좋은 문서를 작성할 수 있게 됩니다.

2. 단순한 개조식 목록을, 더 큰 통찰력을 전달하는 목록으로 발전시킬 방안을 조금의 고민만으로도 알게 됩니다.

3. 불필요한 도해 없이 설명을 마칠 수 있습니다.

4. 긴 설명문을 비약없이 짧게 요약 할 수 있습니다.

5 다수의 요소가 복잡하게 얽힌 구조를 가진 정보를, 단시간에 알기 쉽게 도해할 수 있게 됩니다.

책을 통해서 유익한 점을 저자가 알려준다. 문서의 작성 경험이 많으면 좀 더 쉽게 접근이 가능하고, 평소에 궁금한 점이 있었다면 얻을 수 있는 것이 잘 정리된 책이라서 도움을 받을 수 있다.

체계적인 정보처리와 정리, 보고서나 기획서, 설명서의 작성법의 예를 들어 정리하기에 이해력을 높여주고 있다. 상황에 따라 정보를 전달하기 위한 글쓰기 방법이 있을 것이다. 다양한 상황에 맞는 시스템을 활용하면 효과적으로 내용을 소통하고 전달할 수 있는 방법이기에 정말 많은 도움이 되었다. 가장 기본적인 자료의 정리부터 난이도가 높은 정리의 방법까지 업그레이드를 시켜준다.

1장에서 4장은 자료를 분석 정리하는 방법과 자료 정리에 사용하는 기본적인 용어, 준비를 무엇을 해야하는지 알려주고, 5장부터는 4장까지의 내용을 바탕으로 하여 보고서, 기획서와 제안서, 교육용문서을 작성하는 기법의 예를 알려준다. 파트3인 8장부터 10장까지는 실전에서 사용되는 문서 정리의 테크닉을 알려주는 부분으로 구성되어있다.

문서작성법과 전달 및 이해와 가독성을 중심으로 설명하는 책이라서 목차를 보면서 전달하고자 하는 핵심을 파악하는 구조를 살펴보면 아! 이렇게 목차를 구성하듯이 자료를 정리하면 자연스럽게 가독성과 이해력을 높일 수 있겠다 하는 생각을 하였다

보고서는 복잡한 인과관계를 상태, 트리거, 사고, 손해의 패턴으로 표현하기도 합니다. 사례를 들어서 정보을 전달하는 방법을 설명하고,문제 발생 보고서에 사용하는 정보처리 방법을 문제를 기반구조(Infrastructure), 행동( Activity), 사건 (Event) , 판단(Judge)의 4계층으로 나누어 정리하는 IAEJ의 패턴이다. 그림과 실제 사례를 분석하여 알려주기에 내용을 이해하는 것이 어렵지 않다. 기획서와 제안서는 목료를 향해서 행동을 촉구하는 문서들이라 패턴은 묙표, 현상, 정책이나 PREP, FABE등 기획과 제안할때 사용되는 패턴을 알려준다. 교육용 문서는 (조건, 지시, 이유), Case-Measure, (,사실, 해석, 방침, 영향)의 패턴의 사용방법과 사례를 알려준다.

좋은 보고서는 정보를 전하고자 하는 주제에 맞는 형식을 사용하여, 문제를 정확하게 파악하고 주제를 표현, 최대로 압축한 정보의 양, 가독성과 이해력을 높이는 형식, 주제를 잘 보이게 하고 표현하는 매체가 하나로 통합되면 가독성이 높고 이해력이 높은 보고서나 글이 될것이다.

8장에서 부터 나오는 정보정리 및 문서 작성의 노하우는 개발자를 위한 저자의 세심한 배려로 가독성을 높일 수 있는 현장에서 바로 적용할 수 있는 저자의 노하우를 담았다. 기본적인 용어에 대한 설명, 강조색, 기본색을 사용하는 방법, 들여쓰기, 줄바꿈, 문장을 압축하는 방법등 실전에서 바로 적용이 가능한 노하우를 알려준다.

개인 방송 채널인 유부브도 인지도 높은 진행자는 상업적인 목적이 아닌 구독자를 위해서 1급비밀은 공개를 하지 않지만 그 아래급은 공개를 한다. 전문직에 계시면서 개인방송을 하시는 분들이 공공연하게 비밀로 여겨지는 것이나 전문가들만 아는 내용중에서 선별을 하여 노하우와 지식 및 개인 노하우를 알려주기도 한다. '개발자를 위한 생각의 정리, 문서 작성법'은 글로 소통하고, 정리하는 것이 서툴거나 어려워하는 개발자분들을 위한 내용이지만 일반인도 생각을 정리하거나 내용을 전달하는 방법에 대한 노하우를 함께 배울 수 있을것이라는 생각으로 유용성과 가독성, 이해력을 높이기 위한 다양한 방법을 알려주는 주는 쉽게 정리가 잘 된 책이라서 읽어 보았으면 하고 적극 추천한다.

< 이 리뷰는 네이버카페 책과콩나무의 도움으로 출판사로 부터 책을 받아 개인적인 생각으로 작성 한 것입니다.>