나쁜 문서에 대해

사내 위키를 들여다보며, 안타깝게도 기대 이하 수준을 보이는 문서가 많다. 나쁜 문서를 보면서 공통된 특징을 찾아 몇 가지 언급해본다.

2015년 11월 24일 2차 개정
2015년 5월 3일 1차 개정
2014년 5월 3일 초안 작성

내용

집에서 전자 문서를 자주 보는데, 주로 아이패드를 활용한다. 어두운 방안에서 백라이트가 없는 킨들은 쓰기가 힘들어 아이패드를 이용하는데 특히 PDF 를 보는데 매우 유용하다. 거의 매 주 논문이나 이북(ebook)을 1-2권씩 소화해 내고 있다. 뿐만 아니라 웹 문서를 보는데도 좋다.

웹 문서 중에서는 주로 위키를 보는데 사내 위키(Atlassian Confluence)가 아이패드에서 보기 편하다. 물론 집에서는 읽기(read-only)만 한다. 여러 문서를 꼼꼼히 읽어보면서 궁금한 점은 따로 메모해둔다. Things 에 짤막하게 태스크로 입력하고 다음날 사무실에서 노트북으로 다시 확인하는 식이다.

우리 팀이나 유관 부서의 주요 문서들, 때로는 다른 사람들의 주간 보고도 읽어 보면서 어떤 일을 하고 있는지 들여다본다. 오랜기간 고생하고 있는 분들도 있고 때로는 재밌는 프로젝트도 많다. 가끔은 ‘All Updates’로 전 직원의 문서를 살피기도 한다. 우리 회사 사람들은 어떤 일을 하는지 어떻게 문서를 적는지 살펴보는 재미가 쏠쏠하다.

사내 위키 대부분은 전체 공개로 되어 있어 조금만 관심을 기울이면 많은걸 들여다 볼 수 있다. 이게 침대에 누워 아이패드로 보면서 할 짓인가는 차치한다 하더라도 틈틈히 시간을 내서 읽다보면 회사의 업무나 기술을 이해하는데 많은 도움이 된다.

게다가 다양한 사람들이 다양한 형태로 문서를 적다보니 작성자의 특징이 고스란히 드러난다. 그러나 안타깝게도 부족한 부분이 보인다. 일은 잘하는데 문서는 엉망인 사람도 있고, 자신의 주장과 의견을 효율적으로 전달하지 못하는 사람도 있다. 나쁜 문서를 살펴보면서, 공통된 특징을 찾아 몇 가지 지적하고자 한다.

1. 영어를 못하는 사람

한국 사람이 영어를 못하는건 당연하다.

여기에 대해 뭐라하고 싶진 않지만 좀 너무하다 싶은 경우가 있다. 스펠링이 틀린건 물론이요, AYBABTU 스타일의 영어를 구사하는 사람도 있다. 이른바 콩글리시가 심각한 경우인데, 영어를 더 공부하던지 아니면 차라리 한글로 쓰자. 수준 이하의 콩글리시 때문에 진지한 기술 문서가 웃음거리가 되는건 안타까운 일이다.

2. 한국어를 못하는 사람

영어를 못하는건 당연하지만 우리 말을 못하는건 부끄러운 일이다. 의외로 우리 주변에 우리 말을 못하는 사람이 이렇게 많다는 사실에 새삼 놀란다. 회사 문서에 한글 맞춤법이 틀린 사람이 왜 이렇게 많을까. 기본적인 소양조차 갖추고 있지 못하다니 참으로 부끄러운 일이다. 책 좀 많이 읽고, 글을 더욱 많이 적어봐야 한다. 바른 문장을 자연스럽게 구사할 수 있도록 더 공부해야 한다.

잘못된 우리말의 대표적인 예로 ‘~ 것 같습니다.’ 가 있다. 본인의 생각에 대해서도 확신을 갖지 못하고 불확실한 표현을 사용한다. 문서 전체의 문장이 그렇게 끝난다. 본인이 연구하여 기록한 내용을 확신하지 못한다. 물론 어느 정도의 톤 조절은 필요하다. 그러나 문서 내용 대부분이 불확실한 표현으로 가득차 있는 것은 문제가 있다.

3. 장황한 계획

계획은 장황하게 세우는게 아니다. 실행을 위한 계획이 되어야지 계획을 위한 계획이 되어선 안된다. 그런데, 지나치게 장황하게 계획을 세우고 디테일하게 업무를 나눠 과연 저대로 실행할 수 있을까 의문이 드는 문서가 있다. 문서에 30분 단위로 기입해놓고 그대로 업무를 진행할 수 있다면 천재이거나 또는 반복 작업만 하는 단순 노동자다. 안타깝게도 대부분은 후자다. 분 단위로 예측범위에 들어올 정도의 일만 하는 사람은 항상 하던 일만 하는 사람들이다.

우리는 고도의 지식 근로자이고 항상 창의적이고 예측하기 힘든 일을 예측 범위에 들어올 수 있도록 개선하는 사람들이다. 분 단위로 예측된다는 말은 이미 해봤던 똑같은 일을 반복한다는 얘기이고 이는 매 년 같은 일만 반복하고 있을 가능성이 높다. 10년의 경력이 아니라 1년 경력을 10번에 걸쳐 반복하는 이들이다.

장황한 계획으로 가득한 문서는 반복된 작업으로 가득한, 그다지 좋은 내용이 아닐 가능성이 높다.

4. 지나친 스타일링

문서는 내용이 잘 드러나야 한다.

스타일링에 집중한 나머지 정작 내용은 별 볼일 없는 경우가 있다. 특히 스타일링 때문에 문서 작성에 오랜 시간이 걸린다면 하지 않는게 좋다. 중요한건 내용이고 핵심이다. 잘 보이는게 가장 중요하다. 이쁜 것과 잘 보이는 것은 다르다. 이쁘게 한다고 핵심이 가려지면 시간을 들여 엉뚱한 짓을 하는 셈이다. 주로 사회 초년생들이 교육 자료등의 문서를 이쁘게 꾸미는데 많은 시간을 할애하는데, 엉뚱한 부분에 집중한 나머지 정작 중요한 핵심이 빗나가는 경우가 있다.

5. 기초적인 내용

회사의 사내 문서는 대학생을 위한 교육 자료가 아니다. 기초적인 부분은 과감히 생략하고 핵심에 집중한 고급 정보로 채워야 한다. 물론 기초 또는 기본(basic)이 중요하지 않다는건 아니다. 기본은 매우 중요하다. 그러나 회사에서는 기본은 숙지하고 있다는 가정하에 문서를 작성한다. 그 정도도 모르는 사람이라면 회사에 다닐 능력이 안되는 사람들이다. 회사에 다니기 전에 더 공부해야 한다. 굳이 사내 문서에 일일이 설명해줄 필요가 없다. 문서를 읽는 사람은 최소한의 수준을 갖추고 있어야 한다.

6. 경험은 상세히

반면, 경험은 가능한 상세히 기록해야 한다. 이미 진행했던 일들은 상세할수록 좋다. 상세히 기록된 문서는 많은 사람들에게 귀감이 되고 도움이 된다. 좋은 레퍼런스로 남는다. 물론 여기서도 핵심을 강조하는걸 잊어선 안된다. 상세히 적는데 심취해 무엇이 핵심 인지를 모르고 장황하게 주절된다면 그 것 또한 나쁜 문서다. 핵심을 강조하되 가능한 상세하게 부연설명을 곁들여 필요한 많은 이들에게 도움이 되도록 한다.

is a collection of Papers I have written.
© 2000 - Sang-Kil Park Except where otherwise noted, content on this site is licensed under a CC BY-NC 4.0.
This site design was brought from Distill.