Design Document Writing

대학원에서의 글쓰기와 회사에서의 글쓰기는 기본적으로 다릅니다.

대학원에서의 논문 작업은 정말 고됩니다. 사실 논문 발표할 때 슬라이드 장표는 10장 내외로 마무리되기 때문에 내용은 많지 않습니다. 개요-배경-제안-실험-결과논의-관련연구-결론 순으로 이루어 지기 때문에 생각보다 길지 않습니다. 오히려 논문의 내용이 명확할 수록 이리저리 옆길로 새지 않고 한번에 마무리 지을 수 있거든요. 하지만, 아무래도 논문이라는데(?) 10페이지 내외로 끝내기에는 모양새가 좀 빠져보입니다. 그렇기 때문에 이런저런 이야기를 담아가면서 이야기를 끌고가게 되는데요. 기본적인 기조는 초등학생이 와도 논문을 처음부터 끝까지 읽어보면 설명이 가능하고, 납득이 가능해야한다는 조건이 있기 때문에, 정말 기초부터 하나하나 세세하게 이야기하려고 노력합니다. 그리고 저는 그런 글쓰기를 배우다가 졸업을 하고 회사에 왔습니다.

사실 주니어 개발자 시절에는 생각보다 글을 쓸 일이 별로 없습니다. 모든 굵직한 Design Decision들은 모두 시니어 레벨 혹은 디렉터 레벨에서 결정이 되고, 주니어에게는 그저 주어진 일을 잘 해결하고, 몇가지 제안을 통해서 자기의 생각을 펼처볼 수 있는 기회가 전부이거든요. (물론 회사마다 다르고, 스타트업 같은 경우는 주니어 레벨 개발자에게도 스케치부터 시작해서 모든 작업을 다 맡기기도 합니다.) 그렇기 때문에 커리어 초기에는 (아마 레주메를 제외하고는?) 글쓰기 역량을 발휘하거나 심각하게 이 부분에 대해서 고민할 일이 적습니다.

그런데 중니어부터는 조금 이야기가 다릅니다. 회사에서 바라보는 고객의 문제를 발굴하고, 그 문제를 해결하는 방법을 생각해서 제가 제안해야하거든요. 당연히 모든 회사는 프리젠테이션을 대부분 준비하겠지만, 동일하게 중요한 것이 디자인 문서입니다. 사실 구조는 논문이랑 거의 비슷한데요. 이게 뭔지, 왜 필요한지, 그래서 어떻게 해결할건지, 기존 다른 솔루션은 있었는지, 있었다면 왜 다시 해야하는지, 기존 것을 추가로 고도화를 진행할 것인지, 얻게되는 결과는 정량적으로 어떤지, 요구사항은 뭔지 등 정말 적어야 할 것들이 많습니다.

그래서 대학원에서 늘 하던대로 했죠 뭐..

기초적인 문서를 작업하고, 템플릿을 확인하고 사내에 있는 굿 디자인 독이라는 도장을 받은(?) 문서들을 찾아가면서 문서를 작성하고, 내부적으로 리뷰도 거치면서 어느정도 준비가 되었다고 생각했습니다. 그리고 팀 레벨 리뷰를 하고 코멘트가 처음 나온 것이 이것이었습니다.

This paragraph is too length. I cannot understand what you want to say

오 마이 갓. 논문에서 하던대로 작성했더니 너무 길다는 것이었습니다. 이 코멘트를 보는 순간부터 제 머릿속은 정말 하얘지더군요. 내가 주장하는 내용이고 나발이고 동료들이 알아먹을 수 없다는 사실이 머리를 지배하기 시작했습니다. (뭐 다들 친절해서 이렇게 직설적으로 이야기하는 사람은 얼마 없긴 합니다.) 그리고 다음에는 유관 부서인 런던 팀의 시니어 엔지니어 2명과 같이 미팅을 하는 자리에서 제 문서가 공유되었습니다. 그들의 첫 마디는 이랬었습니다. (다소 의역이 있습니다)

문서가 너무 dense (내용이 많다; **바보 같다**) 해서 이해하기 조금 어렵다

네, 뭐 첫번 째 뜻일거에요. 근데 저는 두번째 뜻에 생각이 더 박히게 되면서 정말 제 글쓰기 스타일을 바꾸지 않고서는 다음 레벨의 커리어 개발도, 다른 사람들을 설득하는 일도 어렵겠다라는 생각이 들더군요. 그래서 사람들과 몇번 미팅을 하였습니다.

너의 말은 무엇인지 잘 알겠어. 그런데 좀 말이 많아

제가 원래 이야기를 바로 포인트로 짚지 않고, 에둘러 말하는 편입니다. 이런 저런 배경설명도 해주고 내가 이걸 왜 해야하는지 등등 많은걸 설명하려고 하거든요. 그러다 보면 이따끔씩 상대방에게 너무 많은 정보를 제공하는 저를 발견합니다. 그래서 동료들, 시니어 엔지니어들이 저에게 이런 충고들을 해주곤 합니다.

1. 글은 최대한 간결하게 네가 하고 싶은 포인트만 이야기 해야한다.
2. 한 문단에 문장이 2-3 개가 넘지 않게 하자. 그만큼 글이 압축적으로 잘 표현되어 있어야 한다.
3. 너는 필요하다고 생각할지도 모르지만, 나는 필요하지 않을 수 있다. 독자층을 잘 타깃해야한다.
4. 문법적인 오류가 있는지 없는지 잘 확인해봐라
5. 필요하면 도움을 요청해라 주변 동료들은 기쁘게 같이 봐줄것이다.

사실 4,5 항목은 학교에서나 할법한 건데,, 동료들이 너무 친절하더라구요. 자기들은 이런거 하는거 기쁘다나 뭐라나.. (업무에서 벗어나서 사실 기초적인 영어만 보고 어떻게 표현하는 것이 더 정확한 표현인지 같이 고민하는 것이 더 좋은가 봐요) 아무튼 여러가지를 배우게 되었습니다. 대학원과는 다르게 미주알 고주알이 아니라 내가 하고 싶은 말은 이말이야! 라고 바로 포인트로 들어가는 것. 그리고 영어로 작성하게 될 경우 문법적인 오류, 문장의 완결성, 그리고 문장의 의미가 내가 말하고자 하는 의미와 정확하게 일치하는지 proof reading을 여러번 하는 등의 포인트등이 도출되었습니다.

부디 여러분은 저와 같은 실수를 반복하지 않기를 (아마 저만 글을 잘 못쓰는걸 거에요..)