왜 이 책을 읽어야 하는가?
많은 사람들이 생각하는 개발자 특유의 이미지가 있죠. 🤓
체크남방, 판교 사투리, 독특한(..) 커뮤니케이션
저도 아니라고 말하고 싶지만 커뮤니케이션은 늘 어려운 숙제입니다.
지식이 없는 상대에게 전문분야를 설명하고 납득시키는 게 말처럼 쉽지 않으니까요.
추상적인 개념을 말로 표현하면 할수록 내가 지금 무슨 소리를 하고 있는 건가 싶을 때가 있죠.
저보다 뛰어난 지식과 경험을 가진 상대에게는 제가 조금 서툴게 설명해도 귀신같이 알아차려줍니다.
하지만 회사에서 누군가에게 보고할 때, 모든 상대가 해당 분야에 지식을 가지고 있지는 않죠.
그렇다 보니 보고를 피하고 싶고 진땀나고 생각만 해도 막막합니다...
그런 고민을 위해 찾아보게 된 책이 '개발자를 위한 생각의 정리, 문서 작성법'입니다.
이 책은 아마존에서도 압도적인 호평을 받으며 저도 추천받아 읽기 시작했습니다.
IT 업계인을 위한 책이지만 보고서는 어느 회사나 작성하니 모든 직장인에게 도움이 되는 내용입니다.
저자는 케이스를 가져와 분석하고 친절하게 방법론을 알려줍니다.
217페이지 정도의 분량이지만 그림이 대부분이라 읽는 시간이 더 짧은 기분이 드네요.
이 책을 읽으며 기억해두면 좋겠다 싶은 부분을 정리해서 독후감을 쓰려고합니다.
범주(Category), 요점(Summary)
요점이란?
보고서를 쓸 때는 모든 정보를 전부 넣는 게 아니라 정보를 분석하고 취사선택 해 재구성 해야 합니다.
줄글을 사용하지 말고 짧게 정보를 정리하란 것이죠.
아래 내용은 Java 위키에서 가져온 줄글입니다.
자바의 개발자들은 유닉스 기반의 배경을 가지고 있었기 때문에 문법적인 특성은 파스칼이 아닌 C++의 조상인 C 언어와 비슷하다. 자바를 다른 컴파일언어와 구분 짓는 가장 큰 특징은 컴파일된 코드가 플랫폼 독립적이라는 점이다. 자바 컴파일러는 자바 언어로 작성된 프로그램을 바이트코드라는 특수한 바이너리 형태로 변환한다. 바이트코드를 실행하기 위해서는 JVM(자바 가상 머신, Java Virtual Machine)이라는 특수한 가상 머신이 필요한데, 이 가상 머신은 자바 바이트코드를 어느 플랫폼에서나 동일한 형태로 실행시킨다. 때문에 자바로 개발된 프로그램은 CPU나 운영 체제의 종류에 관계없이 JVM을 설치할 수 있는 시스템에서는 어디서나 실행할 수 있으며, 이 점이 웹 애플리케이션의 특성과 맞아떨어져 폭발적인 인기를 끌게 되었다.
이 내용을 중요한 부분만 뽑아서 요약한다면.
- 자바는 유닉스 기반이라 C언어와 비슷하다.
- JVM이란 가상 머신이 필요하다.
- 어느 플랫폼에서나 동일한 형태로 실행되어 플랫폼 독립적이다.
- 이런 점이 웹 애플리케이션의 특성과 맞아 인기를 끌게 되었다.
이렇게 정리할 수 있겠죠. 줄글보다 훨씬 읽기가 편해졌습니다.
하지만 항목이 너무 많을 때는 오히려 가독성을 해칠 수 있기 때문에.
분류를 나눠주는 게 더 효과적입니다. 예를 들어.
- 고대 그리스: 민주주의, 철학, 예술, 과학 등이 발전했습니다. 소크라테스, 플라톤, 아리스토텔레스와 같은 철학자들이 영향을 미쳤습니다.
- 로마 제국: 로마 제국의 팽창은 서양 문화와 법률에 큰 영향을 주었고, 기독교가 로마 제국의 공식 종교로 채택되었습니다.
- 서로마 제국 멸망: 서로마 제국이 멸망하면서 중세 시대가 시작되었습니다. 유럽은 봉건제 사회로 전환되었습니다.
- 십자군 전쟁: 유럽 기독교 국가들이 이슬람 국가와 싸우면서 문화적 교류가 일어나고, 동서양 간의 상호작용이 증가했습니다.
- 산업 혁명: 영국을 중심으로 기계화된 대량 생산이 시작되었고, 도시화와 노동계층의 변화가 일어났습니다. 이는 경제와 사회 구조를 근본적으로 변화시켰습니다.
- 프랑스 혁명: 프랑스 혁명은 민주주의, 평등, 인권 등의 개념을 확립했고, 유럽 전역에 혁명적인 영향을 미쳤습니다.
- 제1차 세계대전: 세계 대전은 대규모 파괴와 정치적 변화를 초래했습니다. 전쟁 후 국제연맹이 만들어졌고, 전세계적인 갈등과 변화가 일어났습니다.
- 제2차 세계대전: 나치 독일과 일본 제국의 침략과 연합국의 승리로 끝난 이 전쟁은 정치, 경제, 사회적으로 엄청난 영향을 미쳤고, 유엔(UN) 창설로 이어졌습니다.
이런 항목이 나열되어 있다면 굉장히 보기도 어렵겠죠.
분류로 공통점을 묶어 보면 아래처럼 나눌 수 있습니다.
- 기원 전
- 고대 그리스: 민주주의, 철학, 예술, 과학 등이 발전했습니다. 소크라테스, 플라톤, 아리스토텔레스와 같은 철학자들이 영향을 미쳤습니다.
- 로마 제국: 로마 제국의 팽창은 서양 문화와 법률에 큰 영향을 주었고, 기독교가 로마 제국의 공식 종교로 채택되었습니다.
- 중세
- 서로마 제국 멸망: 서로마 제국이 멸망하면서 중세 시대가 시작되었습니다. 유럽은 봉건제 사회로 전환되었습니다.
- 십자군 전쟁: 유럽 기독교 국가들이 이슬람 국가와 싸우면서 문화적 교류가 일어나고, 동서양 간의 상호작용이 증가했습니다.
- 근대
- 산업 혁명: 영국을 중심으로 기계화된 대량 생산이 시작되었고, 도시화와 노동계층의 변화가 일어났습니다. 이는 경제와 사회 구조를 근본적으로 변화시켰습니다.
- 프랑스 혁명: 프랑스 혁명은 민주주의, 평등, 인권 등의 개념을 확립했고, 유럽 전역에 혁명적인 영향을 미쳤습니다.
- 현대
- 제1차 세계대전: 세계 대전은 대규모 파괴와 정치적 변화를 초래했습니다. 전쟁 후 국제연맹이 만들어졌고, 전세계적인 갈등과 변화가 일어났습니다.
- 제2차 세계대전: 나치 독일과 일본 제국의 침략과 연합국의 승리로 끝난 이 전쟁은 정치, 경제, 사회적으로 엄청난 영향을 미쳤고, 유엔(UN) 창설로 이어졌습니다.
보고서를 작성할 때도 정보를 묶으면 훨씬 읽기 쉬워집니다.
범주란?
범주는 요점을 분류하는 항목의 이름입니다.
범주라는 단어가 잘 와닿지 않고, 포괄적인 용어이기 때문에 글에서 범주를 생략하기 쉬운데.
책에서 나온 예시로 한 번 살펴봅시다.
| 현재 에너지 가격이 전년 대비 30% 상상하는 바람에 큰 타격을 입었습니다. | |
| 범주 | 요점 |
| 에너지 가격 | 전년 대비 30% 상승 |
| (불명) | 큰 타격 |
문장으로 봤을 때는 어색함을 느끼지 못 했지만 표로 보면 범주가 빠진 게 바로 보입니다.
이렇게 주어가 없으면 읽는 사람마다 다르게 해석하거나 혼란스러울 수 있겠죠.
범주와 요점의 차이점
| 범주 | 요점 |
| S사 신기술의 장점 | 반도체 생산 비용 1/3 |
| S사 신기술의 장점 | 반도체 생산 리드타임 반감 |
표로 봤을 때, 범주는 확실히 포괄적이며 구체적이지 않습니다.
반면 요점은 장점에 대한 구체적인 내용을 나타냅니다.
그리고 요점은 몰랐던 정보를 확정하는 역할도 합니다.
| 요점 | 요점의 의미 |
| 오류 검출 기능 추가 | 새로운 오류 검출 기능을 탑재하자 |
| 오류 검출 기능 | 오류 검출 기능을... 어떻게? |
| 오류 검출 기능 삭제 | 오류 검출 기능을 삭제하자 |
요약은 중요하지만 너무 짧게 쓴다면 중요한 단어를 빠트릴 수 있습니다.
그래서 요점만 보고도 정보의 내용을 확실하게 파악하는 게 중요합니다.
모든 보고서는 3줄로 요약한다★★★
아마 이 책에서 가장 중요한 내용이 아닐까 싶습니다.
작업 진행 사항, 장애 보고 등... 어떤 보고서라도. 문서가 아니라도 정보를 전달할 때 아주 유용합니다.
단순 요약과 달리 보고를 듣는 상사의 입장에서 가장 궁금한 것은
바로, bad information (나쁜 일인가?) 하는 것입니다.
서두에 이 보고가 안 좋은 일인지, 아닌지 먼저 알려준다면 일상적인 업무인지 바로 알 수 있죠.
그럼 이 단계에서 상사는 "그래? 나머지는 잘 부탁해!"라는 한 마디로 보고가 끝날 수도 있습니다.
만약 다음 단계로 넘어간다면 보고의 요점, 요약한 내용을 앞에 배치합니다.
안 좋은 소식이라도 중요도는 다를 수 있죠. 중요도가 낮다면 자세히 읽지 않아도 됩니다.
요점을 통해 즉시 중요도를 알 수 있으면 더 읽을지 아닐지 판단할 수 있겠죠.
결론부터 말해!
이런 말을 들어보신 적이 있나요?
보고든 면접이든... 말을 잘 하는 방법을 보면 꼭 두괄식으로 말하라는 걸 팁으로 주죠.
실제로 이 책에서 주구장창 얘기하는 것도 요점을 먼저 말하라는 것입니다.
하지만 실제로 두괄식으로 말해봤을 때, 다음으로 많이 들은 말이 "그래서 무슨 뜻이야?"입니다.
구구절절 설명했더니 결론부터 말하라 그러고.
결론부터 말하면 처음부터 설명하라 그러고.
대체 어쩌란 거야? 하는 마음이 들 때는 아래 내용을 참고해보세요.
PREP 패턴
프렙이라고 부르는 이 패턴은 가장 중요한 요점(결론)부터 시작하는 두괄식입니다.
- Point(요점): 핵심 내용. 내가 말하고 싶은 것.
- Reason(이유): 주장을 뒷받침 하는 근거.
- Evidence(증거) / Example(예시) : 이유에 대한 증명(주로 정량적), 예시.
- Point(요점): 마지막으로 핵심 내용을 강조.
위 프렙 패턴에 해당하는 예시를 봅시다.
| 요점 | 인력 부족을 해소하기 위해, 원격 근무 제도를 확충해야 합니다. |
| 이유 | 유능하지만 풀타임 출근이 어려운 인재를 채용하는 데 유리하기 때문입니다. |
| 증거 | 해당되는 인재가 수도권만 해도 10만 명이라는 데이터도 있습니다. |
| 예시 | 실제로 당사의 동일 업종에서 성공한 사례도 있습니다. |
| 요점 | 그러므로 원격 근무 제도의 도입 검토를 시작해도 괜찮겠습니까? |
결론이 있고 그에 맞는 이유와 뒷받침해주는 증거/예시가 있습니다.
중요한 건 요점 뒤에 바로 이유와 증거, 예시를 같이 제시해야 된다는 점입니다.
그럼 왜 원격 근무가 필요한지, 읽는 사람이 의문을 가지면 그에 대한 답변이 바로 이어지는 거죠.
책은 제가 인상적으로 보고 실제로 현업에서 보고서를 쓸 때 사용할 수 있는 내용을 정리해두었지만
책 본문에는 더 자세하게 설명해주고 유용한 내용이 많기 때문에 꼭 한 번 읽어 보는 걸 추천합니다!
