테크니컬 라이팅: 매뉴얼 쉽게 만들기

김온양
예동이

우리는 흔히 매뉴얼은 제품의 부수적인 존재라고 생각한다. 그러나 매뉴얼은 엄연히 제품의 중요한 한 부분으로, 제품의 완성도와 품질에 직결되는 요소이다. 매뉴얼은 마케팅 도구이며 지식경영의 대상이고, 제조물책임법의 적용 대상이기도 하다. 아래와 같은 체계적인 절차를 통해 매뉴얼을 작성하도록 한다.

기획 – 정보를 수집하고 매뉴얼의 대상과 방향을 설정
설계 – 목차를 구성하고 표제어와 넘버링 시스템을 결정
집필 – 정확하고 어법에 맞는 문장을 작성하고, 체계적인 문단을 구성
연출 – 잘 읽히기 위한 타이포그라피와 잘 보이기 위한 레이아웃, 잘 이해시키기 위한 도해화
검증 – 체크리스트를 통한 단계별 확인
제작 – 인쇄 매뉴얼과 디지털 매뉴얼 작업 시 주의점

역시 오프라인 서점의 매력은 예상치 못한, 그러나 필요한 책들을 눈으로 훑다가 발견할 수 있다는 점이다. 반디 앤 루니스에 가서 발견한 이 책도 그런 의미에서 ‘깜짝 수확’이었다. 그 동안 온갖 White Paper, Spec Sheet, 매뉴얼, PT자료, 홈페이지, 기사, 광고 등을 작업해 오면서 테크니컬 라이팅에 대한 체계적인 지침이 필요하다는 생각이 많이 들었다. 그런데 회사에서도 그렇고 개인적으로도 그렇고 일반적인 작문의 수준에서만 작성을 하는 데에 그쳤던 것이 사실이다. 매뉴얼의 경우 규정에 따라 설계를 하고 설계 승인이 나면 작업을 하고 발표회도 갖게 되어 있지만 잘 지켜지지 않은 경우가 대부분이었다. 또한 구성 이외의 Typewriting이나 읽기 편하게 만드는 요소, 외관 등에 대한 고려도 턱없이 부족했다. 고려해야 하지만, 또 공감은 하지만 잘 못하고 있었던 일들을 일깨워주고 어떻게 해야 하는가를 알려주고 있다는 점이 이 책의 가치라 할 수 있다.

기획, 설계, 집필의 단계도 중요하지만 더욱 관심을 갖고 읽은 부분이 연출 단계였다. 폰트의 크기, 종류, 스타일을 알맞게 조정하고 화면 구성을 짜임새 있고 일관적으로 하는 일이 매우 중요하다. 특히 비슷한 유형의 문서 작업이 많아지면서 동일한 포맷으로 출력될 수 있는 원형이나 기본틀의 필요성이 커졌다. Latex를 전직원이 쓰기에는 한계가 있을 것이고, 결국 웹에서 해답을 찾을 수는 없을까 하는 생각이 든다. (웹을 통해 쉽게 쓸 수 있는 Latex도 괜찮을 것 같다) 작성하는 사람은 스타일 등에 신경 쓸 필요 없이 필요한 위치에 텍스트만 배치하면 알아서 설정, 포맷하여 PDF 형태 등으로 출력시켜주는..

또한 연출 단계에서 중요한 것은 시각화이다. 각종 이미지와 다이어그램, 표를 구성하고 배치하는 작업이 갈수록 중요해지고 있다. 이미지의 경우 해상도와 밝기 등을 고려해야 한다. 시각화에 직결되는 페이지 레이아웃은 머리글, 바닥글, 본문, 이미지, 표, 다이어그램 등이 어우러져 짜임새 있게 보일 수 있도록 해야 한다. 특히 PDF 형태로 배포되는 경우가 종이로 프린트하는 경우보다 훨씬 많기 때문에 여백을 없앤다거나 2단 구성을 활용하는 것 등이 필요하다. 빈 공간이 너무 많이 남는 것은 허술한 인상을 줄 수 있다.

테크니컬 라이팅에 초점을 맞춘 책은 아니었지만 비슷한 분야의 책으로 ‘한국의 비즈니스맨은 글쓰기가 두렵다’를 작년에 읽었다. 또 지금 읽고 있는 책이 미국에서 글쓰기 분야의 클래식이라 할 수 있는 ‘The Elements of Style’이다. 글쓰기의 중요함은 아무리 강조해도 지나치지 않은 것 같다. 자신을 표현하고, 여러 가지 일과 고민과 생각들을 정리하고, 남을 설득하고 이해시키는 일련의 행위에 있어 글쓰기 이상으로 효과 있는 수단은 없다. 말하기가 일회적이고 즉흥적이라면, 글은 생각을 정리해서 쓰는 것이기에(혹은 읽는 이가 그렇게 기대하고 있기에) 더욱 책임을 느껴야 하고 또 한 번 쓴 글에 대해서는 검토를 해야 한다.

Author: mcpanic

어떻게 하면 보다 사람냄새 나는 기술을 만들 수 있을까 고민하는 Human-Computer Interaction (HCI) 연구자 / 컴퓨터과학자 / 새내기 조교수