개발자를 위한 생각의 정리, 문서 작성법

체계적인 정보 정리부터, 보고서·기획서·설명서의 구체적인 작성법과 테크니컬 라이팅까지

카이마이 미즈히로 지음 | 안동현 옮김

프리렉 2024년 06월 21일 출간 국내도서 : 2024년 05월 17일 출간

작품소개

책소개

사양을 설명하거나 오류를 보고할 때 혹은 시스템 제안서를 작성하여 제출할 때, 상대방과 좀처럼 말이 통하지 않아 고생했던 경험이 있지 않나요? IT 개발자란, 사람들에게 복잡한 이야기를 이해하기 쉽게 설명해야 하는 직업입니다. 그러기 위해서는 먼저 자신부터 내용을 가장 잘 이해하고 있어야 합니다. 여기서 필요한 것은 많은 정보를 단순히 기억하는 것이 아니라, 자기만의 방식으로 소화하여 사고를 정리하고 재구성하는 일입니다.

Part 1. 많은 생각과 정보를 어떻게 '내 생각과 정보'로 만들지?
- 생각/정보 정리의 정의
- 범주와 요점
- 그룹, 패러렐, 시리즈
- 논리적 사고를 통해 생각을 정리하기
Part 2. 내가 작성한 문서를 왜 다들 이해하지 못하는 걸까?
- 좋은 보고서가 갖춘 4가지 구조
- 백전백승하는 기획서와 제안서
- 일타강사급 교육 문서 작성법
Part 3. 생각을 좀 더 잘 정리할 노하우가 없을까? 한눈에 이해되도록 문서를 더 잘 만들고 싶어!
- 문제와 장애, 원인을 구분하면 설명이 편해진다
- 한눈에 쏙 들어오는 도해 그리기 노하우
- 문서의 양식뿐 아니라, 문장도 '잘 짜는 법'이 있다

복잡한 이야기를 쉽게 설명해야 하는 숙명을 타고난 IT 개발자를 위한 정보 정리 기술과 문서 작성 노하우가 바로 여기에 있습니다.

목차

들어가며

Part 1. 정보 정리에 필요한 기초 지식과 사고방식
1장 정돈되지 않은 정보는 이해하기 어렵다
__01 부하 직원이 쓴 보고서를 이해할 수 없는 상사들
__02 정보 정리는 생각을 정리하는 것이다
__03 논리 도해는 그림으로 설명하지 않을 때도 효과적이다
__04 정보 정리의 분명한 정의
__05 보고서 첨삭을 반복하여 품질을 향상시키자
__06 글만 가득한 문서나 분류 없는 목록은 주의하자!
__07 철저한 요약과 구조화
__08 자주 등장하는 동일 패턴을 응용하자
Point 01 글쓰기 방법만 고민하는 건 무의미하다

2장 긴 글 정리는 범주와 요점에서 시작한다
__01 모든 보고서는 3줄로 요약한다
__02 요약의 열쇠는 범주와 요점
__03 범주와 달리, 요점은 구체적이다
__04 요점의 역할은 몰랐던 정보를 확정하는 것
__05 글에서는 범주를 생략하기 쉽다
Point 02 글쓰기 방법보다, 주제가 무엇인지를 분명하게 하자

3장 복잡하게 얽힌 주제라면 GPS를 떠올리자
__01 복잡한 정보에는 반드시 구조가 있다
__02 가장 단순한 구조는 GPS, 3가지
__03 그룹: 같은 종류의 그룹을 발견하지 못하는 까닭은?
__04 패러렐: 표처럼 보이지 않는 패러렐 구조
__05 시리즈: 순서를 표시한 시리즈 구조
__06 논리 도해의 기본은 GPS(그룹, 패러렐, 시리즈)
Point 03 구조를 글로 표현하는 것은 적합하지 않다

4장 논리적 사고의 기본을 이해하자
__01 논리적 사고란?
__02 논리적 사고는 효율적으로 꽝을 뽑는 방법
__03 로직트리와 MECE의 기본과 그 중요성
Point 04 구조가 그리 중요하지 않은 정보란?

Part 2. 문서에 따른 정보 정리 패턴
5장 보고서
__01 단순한 보고서에 넣어야 할 정보
__02 결론부터 말할 수 없는 까닭
__패턴1 상태·트리거·사고·손해 패턴
__패턴2 구조·사건·대처 패턴
__패턴3 IAEJ 패턴
__패턴4 목적·방침 패턴
Point 05 표현할 형식, 정보의 양, 매체

6장 기획서·제안서
__01 기획서·제안서의 특징
__패턴1 목표·현상·정책·성과
__패턴2 PREP 패턴
__패턴3 FABE 패턴
Point 06 긴 글은 문단(단락)으로 분해하자

7장 교육용 문서
__패턴1 [조건+지시] 패턴
__패턴2 Case-Measure 패턴
__패턴3 사실·해석·방침·영향 패턴
Point 07 구조화의 출발점은 분류다

Part 3. 정보 정리와 문서 작성 노하우
8장 문제 해결에 도움이 되는 정보 정리 노하우
__01 문제 해결 프로세스를 생각하자
__02 목적·목표·방침·정책을 구별하자
__03 전략과 전술을 구별하자
__04 문제·장애·원인을 구별하자
Point 08 분류에 따라, 수를 줄이는 데 의의가 있다

9장 더 좋은 도해를 그리기 위한 시각디자인 기초 지식
__01 도해는 그림이 아니다
__02 대표적인 도해 방법: 논리 도해·그림 도해·그래프·인포그래픽
__03 강조색과 기본색을 생각하자
__04 기본 서체의 선택 방법
Point 09 계층이 다른 분류를 나란히 배열하는 실수

10장 글쓰기 주의사항
__01 문단 구분 기준은 들여쓰기인가, 빈 줄인가?
__02 동어반복은 피해야 하는 것인가?
__03 들여쓰기와 줄 바꿈의 올바른 사용법
__04 언제나 도해가 최고인 것은 아니다
__05 지나치게 긴 문장을 주의하자
Point 10 축을 분리해서 생각하면 기획하기 쉽다

나가며
찾아보기

출판사 서평

<b>“어떤 개발자가 좋은 개발자일까요?”</b>
어떤 개발자가 좋은 개발자라고 생각하나요? 코딩을 빠르게 해내는 개발자? 아니면 다양한 프로그래밍 언어를 다룰 줄 아는 개발자? 물론 이러한 능력을 지닌 개발자도 좋은 개발자입니다. 그러나, 무수히 많은 정보가 쏟아지는 이 시대에 다양한 사람과 협업해야 하는 현실이라면 이야기는 달라집니다.
〈br〉
<b>좋은 개발자=프로그래밍 실력+정보 정리 기술+커뮤니케이션 능력(글쓰기와 대화)</b>
〈br〉
코딩과 프로그래밍 실력에 더해 깔끔한 정보 정리 기술과 커뮤니케이션 능력까지 겸비한 개발자가 좋은 개발자이자, 한 단계 앞서 나가는 개발자가 될 수 있습니다. 컴퓨터를 구동하기 위해 프로그래밍 언어가 필요한 것처럼, 원만하게 협업하고 업무를 수월하게 진행하려면 특별한 ‘언어’가 필요합니다. 이 책은 바로 이 ‘언어’가 되는 정보 정리 기술을 소개하고, 이 기술을 접목하여 실제로 종류별 문서는 어떻게 작성하는지 설명합니다.

무수히 많은 정보와 생각을 정리하는 방법부터 현업에서 자주 작성하는 보고서·기획서·설명서의 구체적인 작성법과 테크니컬 라이팅까지, 개발자 출신 작가의 노하우를 이 책에서 쏙쏙 알아갈 수 있습니다!

작가정보

저자(글) 카이마이 미즈히로

(開米 瑞浩)
1986년 도쿄 대학 이과 1류에 입학했지만, 커뮤니케이션에 어려움을 겪어 중퇴한 후에 프로그래머로 사회생활을 시작했다. 직장에서도 역시 커뮤니케이션 문제를 겪었지만, 이러한 경험을 바탕으로 복잡한 IT 정보를 논리적으로 구조화하여 도해로 설명하는 방법을 개발했다. 이를 교육 연수 커리큘럼으로 만들었고, 2003년부터 독립하여 기업에 초빙되어 인재 교육을 강의하고 있다. 《エンジニアのための?わる書き方講座(엔지니어를 위한 글쓰기 강좌)》, 《エンジニアを?明上手にする本(엔지니어를 설명 고수로 만드는 책)》(모두 국내 미출간)
등 13권의 저서를 출간하였다. 기술, 과학 분야 글을 기고하고 있으며 교재도 개발 중이다.

번역 안동현

연세대학교 심리학과를 졸업하고 웹 개발 프리랜서를 거쳐 IT 전문 출판사에서 기획과 편집 업무를 담당했다. 번역서로 《빅데이터 시대, 올바른 인사이트를 위한 통계 101×데이터 분석》, 《프로그래머, 수학으로 생각하라》, 《처음 만나는 머신러닝과 딥러닝》, 《HTML5 & API 입문》, 《데이터 해석 입문》, 《건강한 프로그래머》 (이상 프리렉), 《이렇게 쉬운 통계학》 (한빛미디어) 등이 있다.