Developing Quality Technical Information_2. 사용자 중심으로 잘 만들어졌는가

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

2019.04.30 Scripted by
CEO

Task orientation checklist

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

관점에 따라 달라지는 용어

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중심인지 측정할 수 있는 항목들	아래와 같은 부분을 체크해 보세요
대상 사용자에 맞추어 작성되었나?	문서 개발 전에 누구를 대상으로 작성하고 있는지, 독자를 명확하게 상정하고 시작 했는가? 대상 독자가 수행해야 할, 적절한 내용으로 수록되어 있는가? 설명의 깊이가 대상 독자에게 적절한가? UI 화면에 표현되어 있는 메뉴 기능의 이름, 기능을 억세스하기 위한 단계, 팝업되는 메시지에 수록되어 있는 용어나 표현 등이 대상 독자의 수준에 맞추어 적절하게 구성되어 있는가?
사용자 관점에서 정보를 전개하고 있는가?	제공된 정보가 대상 독자를 겨냥한 정보가 맞나? 사용자가 반드시 알아야 할 정보, 수행해야 할 정보를 담고 있는가? 제품 상태의 변화라든지 하는 설명이 중요한 것이 아니다. 사용자 입장을 충분히 반영하고 있는가? 어떤 환경에서, 어떤 상황에서 사용자가 그 기능을 필요로 할지, 어떤 기능과 함께 사용하려고 할지, 사용자의 현황에 대한 이해가 제대로 갖춰져야 한다.
사용자가 대상 제품을 사용하면서 달성해야 할 목표에 초점을 맞추어서 작성되어 있는가?	목차에 수록되어 있는 토픽들은 모두 사용자가 목표 달성(제품의 온전한 사용)을 위해서 수행해야 할 일 중심으로 제시되어 있는가? 목차에 수록되어 있는 해야 할 일 목록은 사용자 중심으로 만들어 져야 한다, 제품 중심으로 만들어 지지 않도록 주의해라. 해야 할 일 목록은 사용자의 필요에 부합하는 내용을 다루고 있어야 한다. 비중을 둬야 할 것은 사용자가 수행해야 할 일이지 제품의 특장점이니 UI 화면의 요소 설명 같은 것이 아니다.
제공하는 정보에 대한 실용적인 설명을 제시하고 있는가?	사용자가 수행해야 할 일을 명확하게 인식할 수 있도록 지원해 주는 개념 설명, 참고 정보, 세부 설명, 사실 정보들을 제시해야 한다. 사용자에게 도움이 되는 유용한 정보만을 제시해야 한다.
사용법은 단계별로 명확하게 지시되어 있는가?	방법을 설명하는 지시문의 각 단계 설명은 사용자의 레벨에 맞추어 적절한 길이, 적절한 깊이, 적절한 표현으로 만들어져야 한다. 각 단계별 지시문의 반드시 명령문으로 시작해야 한다. 여러 단계로 나누어 절차를 설명하는 경우, 나뉘어진 각 단계에 포함된 사용자 액션의 숫자, 중요도, 깊이가 각 단계에 고르게 적용되어 있어야 한다. 예를 들면 해당 기능을 수행하기 위한 핵심 절차가 어떤 특정한 단계 하나에 집중되어 설명되어 있는 반면, 특정 행위를 수행하기 전에 필요한 조건에 대한 설명이나, 또는 특정 행위를 수행하고 난 뒤 발생하는 결과에 해당하는 설명이 독립된 하나의 단계로 되어 있다면 각 단계의 무게감이 달라진다. 모든 단계는 깊이나 중요도나 형식에서 일관되어야 한다. 각 단계에 부속되는 하부 절차나, 해당 단계에서 인지하고 있어야 할 옵션 항목 등 순차적이지 않지만 나열되어야 할 정보가 있다면 각 단계 설명시 적절하게 설명되어야 한다. 선택적 단계는 명확하게 표시해야 한다. 조건부 상황에서 진행되는 절차 설명이라면 어떤 조건을 갖추어야 수행되는지를 먼저 밝히면서 시작해야 한다.

원문은 아래와 같다.

Guidelines for task orientation	Items to look for
Write for the intended audience	Audience is clearly defined. Tasks are appropriate for the intended audience. Level of detail is appropriate for the intended audience. Information in messages and user interfaces is appropriate for the intended audience.
Present information from the users’ point of view	Information is directed at users. Information explains what users need to know or do, not the status of the product. Information reflects the users’ position.
Focus on users’ goals	Task topics are provided that support goal-oriented scenarios. Task topics are user oriented, not product oriented. Task topics address users’ needs. Focus is on tasks, not features and interface elements.
Indicate a practical reason for information	Conceptual information, reference information, details, and facts support tasks. Information that is provided is useful to users.
Provide clear, step-by-step instructions	Steps are at the appropriate level for the audience. The first sentence of each step includes an imperative action. Steps are weighted appropriately. Substeps and unordered lists are used appropriately. Optional steps are clear marked. Conditional steps begin with the condition.

[Developing Quality Technical Information]의 분류에 따르자면, 기술문서가 사용자 관점에서, 사용자 중심으로 제작되어 있는지는 해당 문서를 얼마나 사용하기 쉬운지 (Easy to use)에 기여한다고 했다. 그밖에 Easy to use에 해당하는 항목은 문서에 수록된 정보의 Accuracy와 Completeness가 있다. 이에 대한 체크리스트는 3편과 4편에서 계속하겠다.

Developing Quality Technical Information_2. 사용자 중심으로 잘 만들어졌는가

중국 우한팀의 오피스 이전

2019 World IT show 컨퍼런스 참관기 1

Developing Quality Technical Information_2. 사용자 중심으로 잘 만들어졌는가