클린 코딩과 클린 보고서

알아먹기 쉬운 데이터 분석 보고서 만들기

근래에 다양한 데이터 분석 기반 보고서를 만들게 되었다. 항상 보고를 끝내고 나서 보고서가 내가 생각했던 만큼 완벽하지 않았다는 느낌이 뒤따라 왔다. 그중에서 가장 찜찜했던 부분은, 보고서에 내가 생각 하기에는 유의미한 데이터인데 보고를 받는 사람에게는 이해하기 너무 어려운 데이터들이 다수 포함되어 있다는 느낌을 받은 것이다.

나름 쉽게 이해할 수 있도록 서술하는데 많은 시간을 투자하였다. 그럼에도 불구하고 지속적으로 일어나는 데이터 해석의 어려움은 내가 무언가를 잘못하고 있다는 시그널이라고 생각이 되었다.

그러던 와중에 내가 만든 코드가 재활용하기 너무 어렵고, 또 나중에 다시 보았을 때 나 자신도 이해하기 어려운 코드라는 것을 느끼게 되어 Clean Code라는 책을 읽게 되었다. 그리고 그 프로그래밍 관련 책을 읽으면서 나의 보고서에서 어떤 점이 잘못되었는지 깨닫게 되었다.

저자는 프로그래머들은 자기 자신을 작가라고 여기면서 코드를 짜야한다고 말한다. 작가의 궁극적인 목표는 독자들에게 자신의 글이 읽히는 것이고, 그러기 위해서는 좋은 글을 쉽게 읽히도록, 그리고 간결하게 작성하여야 한다. 프로그래머 또한 마찬가지이다. 글, 즉 코드로 옮기고자 하는 주제가 있고, 그 주제에 대한 글을 써내려 갈 때 이 글이 단지 동작하는 것뿐만 아니라 타인에게 잘 읽힐 수 있도록 작성해야 한다는 것이다.

저자는 잘 읽히는 코드를 쓰기 위해서는 하나의 함수( 하나는 단락이라고 생각 하자)는 하나의 기능(뜻)을 가져야 하고, 그 함수의 이름(단락 서문)은 누가 봐도 쉽게 이해될 수 있어야 한다고 말한다. 그리고 이렇게 최소 단위로 정의된 함수들을 조합하여 하나의 의미 있는 서비스(글)를 쓰는 것이 프로그래머가 하는 일이라고 정의한다.

나는 이 글을 읽으면서 나의 보고서는 어떤 구조로 이루어졌는지 돌이켜 보았다. 각각의 ppt 슬라이드가 하나의 그룹이 되고, 그 그룹 내에 보고서의 최소 단위가 되는 글, 그래프, 테이블이 들어가 있었다. 그리고 그렇게 모인 슬라이드들이 하나의 커다란 맥락을 이루어 독자의 의식의 흐름을 보고서의 결과까지 안내 하거나, 결과 자체를 설명하는 것을 느낄 수 있었다.

문제는 각각의 슬라이드들이 너무 추상화된 그림을 가지고 있거나, 너무 많은 정보를 전달하려고 한다는 것이었다. 그렇기에 ppt를 보여줄 때 항상 나의 구두 설명이 첨부되어야 했다

클린 코드 저자가 말하는 것처럼 코드가 (ppt 슬라이드가) 너무 어럽고 복잡하게 쓰여 있기에 결국에는 낙후되는 코맨트(단발성으로 끝나는 구두설명)가 과도하게 첨부된다는 것이다.

그렇다 먼 어떻게 ppt보고서를 쓰면 좋을까?

일단 각각의 그래프, 테이블, 글이 그 자체만으로 쉽게 이해될 수 있도록 정리해야 한다. 그리고 각 요소들을 사용해 하나의 슬라이드를 만든다면, 그 슬라이드는 단 하나의 의미만 내포해야 한다. 그리고 각 슬라이드는 연결되어 하나의 논리적인 흐름을 만들어야 한다.

마지막으로 ppt 보고서가 구두설명 없이 보고서만으로 쉽게 이해가 되어야 한다