제목이 조금 이상할지도 모르겠다. 문서가 사람처럼 살아 움직인다거나, 삭제하기 전에 조의를 표해야 한다는 게 아니다. 문서를 아무리 꼼꼼히 작성 한다한들, 그 문서의 가치는 사람이 결정한다는 뜻이다.
시스템에 기능을 추가한 후에는 내부 문서화 작업이 뒤따른다. 비즈니스 팀을 위한 초간단 매뉴얼, 그리고 디테일로 꽉 차있는 개발팀 문서. 내부 문서가 있으면 정보를 공유하기가 쉽고 오류를 줄일 수 있다. 글을 쓴다는 게 귀찮긴 하다. 그래도 쓰면 쓸수록 완성되어가는 느낌이 나쁘지 않다. 제목 순서를 정하고, 다이어그램을 넣고, 정보의 정확성을 체크하고, 폰트를 바꾸고, 오타 검사까지 하면 완벽하다. 뿌듯함이 차오른다. 하지만 아무리 작성자의 만족감이 하늘을 찌르더라도, 읽는 사람이 없으면 의미가 없다. 애써 작성했는데 안 읽어준다며 불평해봤자 소용없다. 사람들은 바쁘다. 바쁜 와중에도 읽을만하게 작성해야 한다.
1. 의도가 명확함
읽는 사람 머릿속에는 '내가 이걸 왜 읽어야 돼?'라는 생각이 있다. 누구를 위한 문서인지, 왜 읽어야 하는지를 첫 문단에 적어놓자. 사람은 작성자의 의도를 알고 싶어 한다. 의도를 알면 읽는데 피곤하지 않다.
2. 검색하면 나옴
사람들은 문서를 찾지 않는다. 정보를 찾는다. 자신이 찾는 정보가 어디 있는지 모른다. 그래서 검색을 한다. 검색 결과에 관련 문서가 나오지 않으면 '문서화를 안 해놨네...'라며 실망할 것이다. 문서화를 해놨어도 검색어가 포함되어있지 않으면 결과에 나오지 않는다. 문서와 검색어의 연관성을 높여야 한다. 태그나 해시태그로 표시하는 걸 추천(예를 들어 '데이터 센터'에 관한 문서라면 => #서버).
3. 길이가 적절함
사람을 때리려는 게 아닌 이상, 일부러 두꺼운 책을 찾는 사람은 없다. 간결해야 읽을 마음이 생긴다. 긴 글은 보기만 해도 지친다. 꼭 필요한 정보만 담고 장황한 단어는 다 빼자. 더 이상 필요 없는 정보는 지우거나 아카이브로 옮기자. 예시를 여러 개 들어야 한다면 표로 정리하자(전체 그림을 이해하기 쉽고 단어 수도 줄어든다).
4. 단어가 쉬움
단어가 어려우면 머릿속에서 풀어내느라 에너지가 소모된다. 에너지가 소모될수록 읽는 행위 자체가 싫어진다. 쉬운 단어만 골라 쓰자. 전문 용어도 꼭 필요한 경우에만 사용하자.
5. 잘 생겼음
폰트, 글자 크기, 형식, 문단 모두 가독성에 영향을 준다. 외형이 지저분한 글은 쳐다만 봐도 힘이 쭉 빠진다. 사람의 뇌는 패턴을 좋아한다. 1,3,5,7,9... '모두 홀수다!'라는 생각이 들지 않았는가? 뇌는 열심히 일하고 싶어 하지 않는다. 일관성을 찾아 과부하를 줄인다. 패턴이 느껴지도록 문서 구조와 스타일을 일관성 있게 유지해야 읽는 사람이 피곤하지 않다.
결론은 간단하다. 내부 문서는 읽는 사람 입장을 생각하며 써야 한다. 나의 글쓰기 스타일이나 감성을 뽐내는 자리가 아니다. 정보 전달에 충실해야 한다. 쉽게 찾을 수 있고, 읽기 편한 문서가 사랑받는다.
