사용자 도구

사이트 도구


사이드바

blog:strange-habits-when-writing-a-document

문서를 작성하는 이상한 습관들

제 직업은 누군가를 문서로 설득해서 내 생각대로 움직히도록 하는 일입니다. 문서 이전에 직접 얼굴을 맞대고 진행하는 협의 과정이나 문서 이후의 개발진행에 따른 지원 역시 일의 큰 부분을 차지하지만 업무의 핵심은 목표와 세부사항을 나타낸 문서입니다. 문서를 작성하면 간접적인 피드백을 받게 됩니다. 가령 계획한 기능을 기간 내에 개발하고 유저들로부터 좋은 평가를 받았다면 이번 문서작업은 성공적이라고 간접적으로나마 평가할 수 있을 것입니다. 물론 그 반대의 경우가 훨씬더 많고요. 다른 분들이 문서를 작성하는 과정을 돕기도 합니다. 다행히도 문서를 조금 더 오래 써 보면서 문서로부터 풍기는 이상한 냄새를 좀더 잘 발견할 수 있어 다른 분들의 문서에도 코를 갖다대보는 정도의 역할입니다. 몇 가지 자주 마주치는 이상한 습관을 나열해보려고 합니다.

안전한 보관을 거부

디지털 문서는 물리적으로 아주 불안정한 기반 위에 있습니다. 내 컴퓨터에 달린 스토리지 기기는 미세한 입자들의 전기적 상태에 따라 저장됩니다. 물리적 충격, 전기적 자극, 자력, 장기간 방치에 따른 전력 감소 등 디지털 문서를 사라지게 만들 원인은 얼마든지 이야기할 수 있습니다. 소프트웨어는 어떨까요. 하드웨어의 펌웨어, 운영체제, 그 위에서 돌아가는 수많은 드라이버, 문서를 작성한 소프트웨어 등 중간에 어느 것 하나만 오동작해도 디지털 문서를 열 수 없게 됩니다. 사실 우리가 당연하게 문서를 열고 수정하고 저장하는 과정은 사실 수많은 사람들의 작업물이 거의 기적적으로 문제 없이 돌아간 결과입니다. 그래서 문서를 작성할 때 그 문서가 내 컴퓨터에만 저장되어있도록 해서는 안됩니다. 개인 환경에서 작성하는 문서라면 반드시 클라우드 서비스에 실시간으로 업로드하는 환경 - 드랍박스나 원드라이브 같은 - 에서 작업해야 하고 기업 환경에서 작성한다면 짧은 주기로 형상관리도구 - svn이나 퍼포스 같은 - 에 올려야 합니다.

문서를 짧은 주기로 형상관리도구에 올리라는 가이드는 쉽게 저항에 부딪치는데 가장 자주 접하는 이유는 '완성되면 올리겠다', '이 수정이 완료되면 올리겠다' 같은 것들입니다. 그냥 중간상태를 올려도 아무런 문제도 되지 않는다고 암만 이야기해도 이 이상한 습관을 고치기는 쉽지 않았습니다. 중간상태가 다른 사람들에게 노출되는걸 부끄럽게 생각하는 경향이 있는 것 같았는데 어째서 그런 경향을 가지게 됐는지 쉽게 원인을 떠올리기 어려웠습니다. 궁극적으로는 형상관리도구에서 로컬 커밋과 리모트 커밋을 구분해 - git 처럼 - 중간상태가 다른 사람들에게 덜 노출되도록 하거나 아예 작업과정이 실시간으로 동기화되는 클라우드 기반의 문서 작성 도구를 사용하도록 하는 수밖에 없다는 생각입니다.

비 자발적 협업 방해

같은 문서를 여러 사람이 쓸 일을 피할 방법은 없습니다. 내가 이 일을 계속해서 진행할 가능성이 없고 또 이 팀이나 이 회사에 영원히 남아있으리라 예상할 수도 없습니다. 내가 쓰는 문서는 언제나 다른 사람 손에 넘어가 수정될 수 있고 그 반대의 경우도 마찬가지입니다. 때문에 내 문서는 문서를 읽는 대상에게 목표를 잘 설명하고 또 설득할 수 있어야 하지만 동시에 내 문서를 수정할 나를 포함한 미래의 누군가에게도 목표를 잘 설명하고 또 새로운 요구사항을 문서에 쉽게 추가할 수 있는 구조여야 합니다. 잘못된 문서 구조 - 가령 잘못된 챕터 구분이나 논리적으로 잘못 나뉜 개념 등 - 는 이후 문서에 새로운 요구사항을 반영하기 어렵게 만들고 문서 전체를 재작성하게 만듭니다.

다른 사람이 내 문서를 잘 수정할 수 있도록 문서를 논리적으로 구성하고 구조를 수정하기 쉽게 만들도록 가이드하는데 가장 자주 부딪치는 저항은 어처구니없게도 다른 사람의 문서를 수정해도 괜찮은지 모르겠다는 반응이었습니다. 마치 다른 사람이 작성한 문서는 그 모든 권리가 작성자에게 있는 것 마냥 내가 수정해서는 안되는 무슨 신성한 물것인 것처럼 받아들이고 있었습니다. 회사에서 작성한 문서라면 그 모든 권리는 회사가 가지고 있고 회사의 업무를 위임받은 내가 수정하는데 아무런 문제도 없습니다. 또 다른 사람이 내 문서를 수정하는데 아무런 거리낌도 없어야 하고요. 내 문서는 나를 반영하는 거울 같은 것이 아니라 회사의 자산이고 회사의 자산은 회사의 업무를 위임받은 우리들이 적극적으로 수정하고 활용해야 하는 물건일 뿐입니다.

나쁜 표 사용

적절한 표는 복잡한 설명을 대신할 수 있습니다. 그런데 표를 사용할 상황과 그렇지 않은 상황을 구분하는 훈련은 문서를 몇 년 동안 작성한 분들에게도 잘 되어 있지 않은 경우가 많았습니다. 사실은 거의 대부분이 표를 사용할 상황과 그렇지 않은 상황을 잘 구분하지 못했습니다. 글로 설명하다가 뭔가 설명을 반복할 상황이 생기면 더 고민하지 않고 바로 표로 넘어가곤 했습니다. 하지만 잘못된 표는 문서를 이해하기 어렵게 만들고 또 문서를 수정하기 어렵게 만들기도 합니다.

복잡한 표를 잘 만들 수 있다는 어떤 문서작성도구로 작성한 표 사례의 대부분은 표를 사용할 필요가 없는 경우입니다. 이 경우에 제시되는 사례 대부분은 동사무소나 은행에 있는 어처구니없이 복잡한 신청서입니다. 이런 문서는 실상 습관적으로 표를 이용해서 만들어온 것 이외에 표를 사용할 이유가 없고 이런걸 잘 만들 수 있다고 해서 우리가 문서에 이런 표를 사용해야 할 이유도 없습니다. 표는 필요한 곳에만 제한해서 사용해야 하고 표가 복잡해져 지금 쓰는 문서작성도구의 기능이 부족하다고 느껴진다면 교체해야 하는 건 문서작성도구가 아니라 그 표가 필요하다고 생각하게 만든 사고의 흐름일 가능성이 훨씬 높습니다. 복잡한 표가 필요하다고 느끼면 일단 뭔가 잘못된 것이 아닐지 경계해야 합니다.

도구의 자동화 기능을 무시

문서를 작성하는 일이 직업의 일부라면 여기에 사용하는 도구에 관심을 가져야 합니다. 가령 마이크로소프트 워드 - 이하 워드 - 를 사용한다면 워드에는 글자를 입력하는 기능과 폰트 종류, 크기를 조정하고 표와 그림을 삽입하는 것 이외에 어떤 기능이 있는지 알아둬야 합니다. 가이드할 문서를 보면서 자주 마주치는 상황은 스타일 기능 대신 챕터 제목을 폰트 크기를 조정해서 표현하는 것입니다. 또 번호를 수동으로 매긴다든지 들여쓰기를 스페이스로 한다든지 페이지나눔을 엔터로 하기도 합니다. 이 현상의 공통점은 두 가지인데 하나는 이들을 자동으로 해주는 기능이 있으리라 상상하지 않는 것, 다른 하나는 이들을 자동으로 해주는 기능의 의미를 이해하지 않는 것입니다.

문서는 크게 두 가지 구성방식으로 이해해야 합니다. 하나는 시각적인 구성입니다. 문서는 화면으로 보거나 인쇄해서 볼텐데 이 때 문서의 여러 부분은 나머지와 시각적으로 구분되어 있어야 합니다. 가령 제목과 본문을 구분할 수 있어야 하고 목록은 번호나 기호로 시작해야 하고 또 상황에 맞게 들여쓰여있거나 내어쓰여있어야 합니다. 다른 하나는 의미적 구성입니다. 문서는 시각적인 부분을 제외하고서도 나머지 부분과 구분할 수 있어야 합니다. 제목은 폰트 크기가 동일하더라도 이 부분이 제목이라는 사실을 알 수 있어야 하고 목록은 기호나 번호를 없애고서도 이 부분이 목록이라는 사실을 알 수 있어야 합니다. 이를 위해 시각적인 요소를 자동으로 입력해주는 기능이 있습니다. 제목을 폰트 크기를 바꾸는 대신 스타일을 통해 입력해야 하는 이유는 이게 더 편하고 일관성을 유지하기 쉽기 때문이지만 동시에 제목 부분에 제목이라고 표시해 기계가 이를 참고해 목차를 자동으로 만들 수 있게 해주고 또 문서를 스크린이 더 좁은 모바일 기계에 표시할 때 제목과 본문을 자동으로 구분할 수 있게 해 주기 때문입니다. 자동 목록도 마찬가지이고 자동 들여쓰기나 페이지나눔에 엔터 대신 페이지나눔 문자를 입력해야 하는 것도 마찬가지입니다.

결론

문서 작성을 가이드하며 느낀 이상한 점들은 이밖에도 많습니다. 또 그 이상한 점을 고치기 위한 가이드와 그에 따른 저항 사례도 많고요. 일부는 수정할 수 있었지만 나머지는 결국 수정에 실패해 이전의 '이상한 습관'을 유지한 채 이로 인해 일어나는 문제를 최소화하기 위한 더 복잡하고 더 귀찮은 규칙을 만들기도 했습니다. 놀랍게도 사람들은 문서작성 습관 자체를 수정하는데는 저항하다가도 이상하고 귀찮은 규칙 - 가령 문서를 수정할 때마다 문서 내부에 수정일자와 수정사항의 요약을 기입한다 - 은 쉽게 수긍하곤 합니다. 앞으로도 문서 작성에 이상한 습관을 고치는 방향으로 가이드하겠지만 여전히 이 이상한 습관이 어디서부터 온 것인지는 의문으로 남을 전망입니다.

blog/strange-habits-when-writing-a-document.txt · 마지막으로 수정됨: 2019-03-10 11:53 저자 neoocean