개발자를 위한 생각의 정리, 문서 작성법
개요
얼마 전, 토스 컨퍼런스에서 주니어 개발자들을 위한 몇 가지 팁에 대한 발표를 들은 적이 있다.
발표에서 들은 많은 도움이 된 내용들이 있었지만 그 중 기억에 남는 것은 아래의 내용이었다.
개발자라서 커뮤니케이션, 문서 작성을 미숙하게 하는 것이 아니라 그만큼 관련 업무가 어렵고 복잡하다
(그에 대한 해결법으로 제시해주신 것은 도식화!)
마침 블로그를 다시 시작하는 김에 글쓰기 관련 책을 읽으면서 블로그 글을 어떻게 작성하면 좋을 지 생각했고
더 구체적으로는 어렵고 복잡한 내용의 경우 어떤 식으로 생각을 정리하고 문서를 작성할 지에 대한 방법론에 대해 찾아본 책의 내용을 몇 가지 정리해보려 한다.
요약
- 문서 시작 부분에 3줄 요약을 적어두자
- 강조색은 글을 모두 작성한 후 여기다! 싶은 곳에만 쓰자
- 결론부터 말하는 PREP 패턴을 사용해보자
내용
1. 3줄 요약하기
시작 부분에 요약을 써라
요약의 좋은 점은 본문을 읽지 않고도 개요를 알 수 있다는 점이다.
만약 글을 끝까지 읽어야 문제의 해결 여부를 알 수 있다면, 이는 요점을 알 수 없는 글로 읽는 사람의 부담이 큰 보고서이다.
요약의 방법
책에서는 요약을 위한 방법론으로, 범주(category), 요점, 본문을 분류하는 방법을 제시한다.
원문을 아래와 같은 방식으로 분류하면 요약을 하기 쉬워진다는 것이다.
- 범주: 요점을 분류한 항목의 이름
- 요점: 본문 중 중요한 부분만을 간단하게 표현한 것
- 본문: 한 눈에 알아볼 수 있도록 원문 내용을 분해한 것
글에서 범주를 생략하기 쉽다
특히 범주는 가장 포괄적인 용어이나 막상 글에 생략되는 경우가 잦다고 한다.
위 처럼, 전혀 어색하지 않아보이는 문장에도 범주는 생략되어 있다.
큰 타격의 주어가 생략되어 있는데, 읽는 사람에 따라 다른 해석을 할 여지는 충분하다.
반대로 요점을 생략하면 이 차이는 두드러진다.
- 현재 에너지 가격이 전년 대비 30% 올랐으며 이는 경제 부분에서입니다
따라서 요점 생략은 좀처럼 일어나지 않지만, 범주 생략은 자주 일어날 수 있으니 주의하자.
요점은 구체적이며 확정적이다
범주와 요점을 구분하는 기준은 정보의 구체성이다.
아무리 요점이라해도 구체적인 수치를 빠뜨리면 안된다!
요점의 역할은 몰랐던 정보를 확정하는 것이다.
요점 작성 후, 작성한 요점을 보고 의미를 확정할 수 있는 지 생각해보자.
너무 짧으면 뜻이 통하지 않을 수도 있어, 없어도 될 말인지 신중하게 판단하는 것이 중요하다.
2. 더 좋은 도해를 그리기 위한 시각디자인 기초 지식
정보 전달을 위해 그림을 그리는 것은 좋지만, 더 중요한 것은 논리 관계를 제대로 명시하는 것이다.
심지어 그림 실력은 전혀 문제가 되지 않을 때가 많다.
대표적으로 좋지 않은 시각 디자인 사례를 설명한다.
- 사람 얼굴을 그려 넣는 경우 - 의미 없다
- 아이콘이나 사진만 넣는 경우 - 정확한 의미가 전달되지 않는 경우가 많다.
- 장식, 여백 과다 - 디자인 지식이 없는 사람이라면 역효과가 날 가능성이 높다.
대신 이러한 도해 방법을 주로 사용해보자.
강조색과 기본색을 생각하자
글을 작성할 때, 색을 쓰지 않아도 의미가 통하도록 정보 정리를 철저히 한 후, 정말 강조하고 싶은 부분에만 강조색을 사용해야 한다.
특히 강조색은 볼드체보단, 붉은색과 같은 난색을 의미한다.
웹 디자인에서는 전체를 100으로 가정했을 때, 강조의 비율은 5% 정도로 유지하는 것을 권장한다고 한다.
결론은 강조색은 정말 여기다! 싶은 곳에만 사용하는 것이 좋다!
3. 기획, 제안서
블로그 글과는 약간 관련이 없지만, 읽다 흥미로운 부분들이 있어 추가하였다.
보고서, 요약서가 과거의 이해를 불러일으키는 문서라면, 기획서와 제안서는 미래를 향한 행동을 촉구하는 문서이다.
목표, 현상, 정책, 성과 패턴
목표, 현상, 정책, 성과는 기획서 작성 시 가장 기본이되는 4가지 항목이라고 한다.
만약 아래와 같은 제안 사항을 했다면
코딩테스트에 합격하기 위해 현재 백준 티어가 브론즈1이지만,
앞으로 3개월에 걸쳐서 골드1로 올리는 것을 목표로 삼자.
그리고 하루 1시간 문제 푸는 스터디를 하고, 1시간 강의를 듣자!
패턴에 따라 아래처럼 바꿀 수 있다.
- 목표: 골드 1
- 현상: 브론즈 1
- 정책: 하루 1시간 문제 푸는 스터디를 하고, 1시간 강의를 듣기
- 성과: 티어 상승
이때 기획서에는 목표, 정책, 성과의 개요를 기획의 목적으로 삼고, 정책의 상세를 구체적으로 작성하면 된다.
PREP 패턴
간단히 프렙이라 부르는 아주 유명한 패턴이라고 한다. 결론부터 말하는 화법으로도 종종 소개된다.
- Point(요점): 가장 말하고 싶은 것, 행동을 제안하는 말이 들어간다.
- Reason(이유): 그 행동이 왜 필요한지 효과적으로 설명하는 것
- Evidence(증거): 이유에 대한 근거. 정량적 정보
- Example(예시): 이유에 대한 예시. 개별 사례 정보
- Point(요점): 마지막으로 다시 한번 요점을 반복하면서 마무리
책에서 위 패턴의 예시를 설명하였다.
