[Developing Quality Technical Information]에서 다루고 있는 첫번째 체크리스트는 Task orientation checklist였다. 해당 문서가 대상 사용자가 수행해야 할 Task 중심으로 잘 만들어졌는지를 체크하는 항목이다.
CEO


많은 시간 동안 다양한 매뉴얼을 개발해 오면서 깨닫게 된 것인데, 매뉴얼을 개발하는 라이터가 가장 명심해야 할 덕목은 “사용자관점”이라고 생각한다. 이해하기 쉬운 모든 정보의 출발은 그 정보의 저자가 “얼마나 대상 독자의 관점을 잘 유지하고 있는가”라고 해도 과언이 아니다. 대상 독자의 관점이 적절하게 유지되어야 적합한 용어의 선택, 적합한 표현의 선택, 적합한 설명의 깊이, 적합한 사례 제시, 적합한 목차의 구성, 적합한 레이아웃 디자인이 나오게 된다. 하지만 많은 기술문서가 이해하기 쉬움, 도움됨의 관점에서 실패하는 경우는 대부분 해당 문서에 수록된 콘텐츠가 사용자 중심이 아니라 기기 중심의 설명을 제공하는 경우가 많아서이다. 이 기기가 가진 기능이 얼마나 많고 이 기기가 구현할 수 있는 기술의 정도가 경쟁사 제품 대비 얼마나 뛰어난지 설명하기 위한 상세한 기술스펙을 나열하고, 기능이 화면에서 표시되어 나오는 순서대로 배치하고, 기능 명칭을 그대로 사용자토픽의 제목으로 사용하는 등등 중장비나 산업기기, 매디컬기기, 금속 가공 기계 등 다양한 산업 장비에서 해당 사례를 자주 볼 수 있다. 아무래도 라이터가 대상 제품을 사용할 사람의 입장을 유지하면서 정보를 기술하는 것이 아니라 대상 제품의 기능을 구현시킨 개발자 입장에서 작성하다 보니 벌어지는 실수가 아닐까 싶다.

IBM 도서가 언급하고 있는 Task orientation에 대한 설명은 아래와 같다: Task orientation is a focus on users’ actual goals and the tasks that support those goals. Task-oriented information keeps users “on task.”
Information is task-oriented if it’s focused on what users want to do, not on what the product can do. Be sure that you know your audience, and provide practical information for their needs. The most useful task topics are those that support scenarios to accomplish key goals. Make sure that the steps that you write in task topics are clear and not too low level for your users.
IBM에서 제시한 Task orientation이 적절하게 수행되고 있는지의 척도를, 실무자들이 조금 더 쉽게 이해할 수 있도록 살짝 가공하면 아래와 같다.
Task중심인지 측정할 수 있는 항목들 | 아래와 같은 부분을 체크해 보세요 |
대상 사용자에 맞추어 작성되었나? |
|
사용자 관점에서 정보를 전개하고 있는가? |
|
사용자가 대상 제품을 사용하면서 달성해야 할 목표에 초점을 맞추어서 작성되어 있는가? |
|
제공하는 정보에 대한 실용적인 설명을 제시하고 있는가? |
|
사용법은 단계별로 명확하게 지시되어 있는가? |
|
원문은 아래와 같다.
Guidelines for task orientation | Items to look for |
Write for the intended audience |
|
Present information from the users’ point of view |
|
Focus on users’ goals |
|
Indicate a practical reason for information |
|
Provide clear, step-by-step instructions |
|
[Developing Quality Technical Information]의 분류에 따르자면, 기술문서가 사용자 관점에서, 사용자 중심으로 제작되어 있는지는 해당 문서를 얼마나 사용하기 쉬운지 (Easy to use)에 기여한다고 했다. 그밖에 Easy to use에 해당하는 항목은 문서에 수록된 정보의 Accuracy와 Completeness가 있다. 이에 대한 체크리스트는 3편과 4편에서 계속하겠다.