최근, 사내 테크니컬 라이터 교육 자료로 IBM에서 발행한 [Developing Quality Technical Information] 이란 도서를 구매했다.

2019.04.30 Scripted by
CEO

Developing Quality Technical Information

사내에 여러 도서가 있지만 2014년 3쇄가 발행된 이 자료는 목차를 살펴보니 기술문서를 개발하는 조직이라면 누구라도 도움될 여러가지 정보가 체계적으로 수록되어 있고, 최근 개정되어 출판되었기 때문에, 웹 매뉴얼 등 디지털 환경으로 바뀌고 있는 시대 변화를 잘 반영하고 있으리라는 기대감을 불러일으키기 충분했다. Part 1 Introduction을 제외한 주요 목차를 살펴보면 아래와 같았다.

Part 2. Easy to use
Ch3. Task orientation
Ch4. Accuracy
Ch5. Completeness

Part 3. Easy to understand
Ch6. Clarity
Ch7. Concreteness
Ch8. Style

Part 4. Easy to find
Ch9. Organization
Ch10. Retrievability
Ch11. Visual effectiveness

Part 5. Putting it all together
Ch12. Applying more than one quality characteristic
Ch13. Reviewing, testing, and evaluating technical information

매뉴얼 개발자로 입문한 여러 사람들에게 방향성을 제시해 줄 수 있으리라는 기대로, 새 책이 도착하길 기다렸다. 그리하여 마침내 도착한 책자에서, 목차를 보면서 어떤 내용을 수록했을지 내가 개인적으로 가장 관심이 갔던, 주요 챕터별 체크리스트부터 살펴보았다.

체크리스트는 어떤 기준을 충족시키기 위한 실행 항목들이라고 볼 수 있다. 체크리스트를 제대로 파악한다면 해당 기준을 충분히 충족시킬 수 있게 된다. 문제는 현장에서의 작업 경험이 충분히 쌓이지 않은 상태에서는 체크리스트에 수록된 항목 하나하나의 의미를 문자만 해석해서는 체감할 수 없는 경우가 있다. 그래서 테크니컬 라이터 집단에서는 충분한 현장 경험을 갖춘 시니어그룹과 이제 입문한 주니어 그룹이 함께 일할 때 시너지가 퐁퐁퐁 더 생기지 않을까라는 생각을 늘 하게 된다.

[Developing Quality Technical Information]에서 다루고 있는 체크리스트를 순서대로 살펴 보겠다.