by
Oct 30. 2019
컨펌을 부르는 문서 정리
문서의 UX를 생각하라
"봐봐, 너 리뷰 때는 작업자들이 이해가 다 안 됐는데도 질문을 안 하잖아. 이해하려고 노력하겠다고 그러잖아 그거 이상한 거야. 물론 내용이 너무 많아서 그렇기도 하지만."
사람이 일을 하다 보면 최선을 다하지 않을 때가 있다. 아 이 정도면 진행은 되겠다 판단이 들 때 그렇다. 작업 할당 후에도 수많은 커뮤니케이션이 오가니까, 여기 개발자와 꽤 오래 합을 맞췄으니까. 그게 대수야? 싶은 거다. 그리고 이어지는 선고. "다시 써야겠다. 처음 해보는 사람한테 할당되면 어쩔 건데"
몇 개월의 시간을 쏟아부은 가볍지 않은 기획서에 프로세스도 뭐 꽤 명확히 정리해두었고 복잡한 것을 정리해야 되는 사람으로서 너무 억울한 마음이 드는 거다. 여기까지 정리하기가 얼마나 힘들었는데! 한 단계를 넘어갈 때 대체 어느 정도의 품을 들여야 하는 건지. 그러나 여러 사람에게서 같은 얘길 듣는다면 더 이상 변명거리가 되지 않는다. 퍼뜩 기억나는 주니어 때의 추억. 아 맞다 나는 한결같이 문서정리에 더 신경 써야겠다는 말을 들었지? 그래서 다시 정리해보는 컨펌을 위한 문서 수칙. 신입 때부터 문서가 '예뻐야 한다'에는 크게 동의하지 못했던 터라. 다만 '가독성이 좋아야 한다'에는 공감하는 바.
Photo by Viktor Talashuk on Unsplash그렇게 몇 개월째 씨름을 하고 있는데 리드가 주옥같은 명언을 남겼다. "문서의 UX 생각해서 정리"해라. 그렇지, 문서일 뿐이지 UX는 어디에나 있다! 가만히 의도를 들여다보니 언제나 그렇듯 교과서 같은 너무나도 기본적인 사항.
하고자 하는 바를 문서의 좌측 상단에 정리한다. 문서를 읽는 시선을 의식하라.
하고자 하는 바는 문서만 봤을 때도 이해가 돼야 한다. '무엇을' 다른 설명 없이도 이해될 수준으로 정리한다.
(의사결정권자에게 리뷰할 경우) '이게 무슨 말이죠' 쓸데없는 논의로 새 나가지 않도록 추가 장표를 준비한다. 물론 정규 문서 내에서 해결되는 것이 우선.
그러니까 주어와 목적어를 빠뜨리지 말 것='왜' '무엇을'이 지금 보고 있는 장표에서 모두 해결되야한다.
할 말이 너무 많으면 쪼개라. 한 장에서 모든 것을 해결하려 하지 말라. 단, 여러 장표에 같은 내용이 중복되지 않도록.
