첫 연구 결과물 작성: 문서 산출물
다른 사람의 입장에서 글을 쓰는 연습
IT업계에 비전공자로 입사한 1년간의 이야기 - 8
내가 근무하는 팀은 정보 보안 업계에서 트렌디한 주제를 선정해 연구하는 일을 한다. 연구 실적이 올라가기 때문에 어느 정도 산출물이 나오는 일이 중요한데, 대표적인 산출물로는 ’진단가이드‘, ‘버그바운티 가이드’와 같은 문서를 발표하는 일이 있다.
가이드라 함은 가이드의 목적이 있고, 보통은 ’읽는 사람에게 어떠한 정보를 제공해주고자 함‘이 가이드의 목적이다. 가이드를 읽는 독자 수준을 지정해 두고 그에 맞는 눈높이로 글을 쓴다.
다른 사람의 입장에서 쓰는 가이드는 처음엔 쉬울 줄 알았다. 하지만 대학교 과제와는 결이 너무나 다른 게, 지금까지 썼던 글은 ’남이 읽기 좋은 글‘이 아닌 ‘내 성과를 보여주는 글’이었다는 걸 깨닫게 됐다.
나는 해왔던 대학교 과제의 연장선상으로 아직 문서를 쓸 때 자꾸만 ‘나 이런 거까지 연구해 봤어요!’라며 모든 성과를 집어넣으려 하고, 하나부터 열까지 기초적인 내용부터 설명하는 습관이 있다.
문서를 일 년 넘게 써도 아직도 크고 작은 실수를 많이 한다. 읽는 사람의 입장에서 문서를 쓴다는 건 생각보다 정말 어려운 일이다. 쓰다 보면 계속해서 길을 잃고 내 입장에서만 글을 서술한다. 목차를 뒤집고 뒤집어도 쓰자고 하는 목표에서 벗어나더라.
며칠 전에 정해진 방향성도 문서를 쓰다 보면 어느새 ‘아냐 이것도 넣어주자’라며 같은 주제로 회의를 반복하고 목적에 맞지 않게 너무 기초적인 내용부터 작성을 한다던가. 목차를 다시 봤을 때 필요한, 필요 없는 내용이 새로 보인다거나. 이렇게 문서 하나에 두세 달을 매달리다 보면 내 희로애락이 문서에 다 담긴다.
정말 고맙고도 미안한 우리 팀원들은, 내가 일주일에 5일을 말씨름에 매달려도 천천히 내 방향성을 다시 잡아줬다. 나에게 ‘며칠 전에 이 이야기하지 않았냐..’며 억울해하던 팀원들이 생각이 난다.
문서를 검토하는 습관이 아직도 들지 않아서 선배님께 검토를 받을 때 쓴소리를 많이 듣는다. 함께 문서를 쓰는 선배는 ‘말하고 말해줘도 이렇게 기본적인 실수를 하면 어떡하냐. 내가 여기서 오타나 잡아줘야 하나’라며 일침을 두시기도 했다.
최근에 옆에서 선배님이 쓰시는 글을 몇 번 본 적 있는데 한 문장 문장을 굉장히 공들여서 쓰신다. 괜찮은 문장이 나오면 다음 문장으로 넘어가기 때문에 오탈자가 날 일도, 다시 문장을 수정할 일도 적었다.
또, 중복되는 말을 최소화해서 3줄로 길어진 문장을 간결하게 한 줄로 줄이시곤 한다. 쓰다 보면 앞뒤로 같은 말을 하거나 불필요한 첨언이 너무 들어가는 경우가 많은데, 문장을 간결하게 쓰면서 짧은 문장에 필요한 내용이 다 들어가 전체적으로 문서가 깔끔해진다.
문서를 쓰는 법도 직접 부딪히고 고민하며 깨져야 늘더라. 오랜 작업이 능숙하게 손에 익는 것처럼. 문서를 쓰는 법도 점점 머리로, 눈으로, 손으로 체득하게 된다.
처음부터 끝까지 내 손을 탄 결과물이 나오는 건 이번이 처음이다. 산출물이 세상에 나오면 너무 뿌듯할 것 같다. 작년 하반기에 세상에 나온 PPT가 그랬듯.
아래는 내가 문서를 쓸 때 주로 검토를 하는 내용이다. 문서를 잘 쓰는 첫 번째 방법은 일단 아래 나열된 기본적인 규칙사항을 지키는 일이다.
1. 증적
- URL 자르지 말기, 읽는 사람은 같은 페이지인지 구분하지 못함
- ‘강조해야 할’ 부분만 빨간 박스로 강조하기
- 검색창 등을 네모로 가득 채워 기존의 모양을 가리지 말 것, 읽는 사람은 검색 창이 있는지 모름.
- 기본 계정, 기본 테마로 사진을 찍을 것. 윈도우 창 기준 창을 절반으로 두고 증적 찍기.
- 소스코드를 그림으로 넣을 시 배경 흰색으로
- Burp 패킷은 http 헤더의 URL 부분이 보이도록 찍을 것
- 회사 이름은 로고에 있는 이름 기준
2. 피드백
- 똑바로 메모하고 수정하기
- 이전에 피드백했던 거랑 겹치는 실수 했는지 확인하기
- 오탈자 검수
- 읽는 사람 입장에서 쓰기
누군가 문서를 본다고 하면 부끄럽고, 하나라도 더 좋은 내용을 담고 싶다. 쓰다가 문서에 대한 자괴감이 들었을 때, ‘네게는 정말 쉬워 보이고, 쓸모없어 보여도 누군가에겐 필요한 내용일 수 있다. 처음 이걸 접하는 사람들은 이런 정보도 필요로 한다’며 나를 다독여 준 말이 생각난다.
경험이 쌓이다 보면 다른 사람의 입장에서 보는 법도 필요한 내용을 구분하는 것도 더 잘할 것이다. 큰 그림을 보는 법도 더 배워나가겠지. 지금의 내가 그런 것처럼 몇 년 후의 나는 선배님처럼 문서도 착착 쓰는 법을 배울 것이다. 덤벙대지 말고 잘 검토하고 잘 수정하는 법을 배우자. 중요한 건 글을 쓰는 걸 두려워하지 않는 것이다. 의심하지 말고 일단 적어간 후, 다듬고 다듬어 좋은 문장을 내는 사람이 되자.
