Developing Quality Technical Information_4. 수록된 정보가 완전한가_Completeness checklist

[Developing Quality Technical Information]에서 다루고 있는 세번째 체크리스트는 Completeness checklist였다. 기술 문서가 얼마나 사용하기 쉬운지(Easy to use)에 기여하는 마지막 요소이기도 하다.

일반적으로 매뉴얼 개발을 전담할 테크니컬 라이터를 지도할 때 정보의 완전성에 대해서는 ‘대상 제품이 가진 모든 기능을 수록할 것, 사용자의 호불호를 정의하여 라이터가 임의로 설명을 생략하는 기능이 없도록 할 것, 각각의 Task에 대한 설명은 대기 모드에서 시작하여 해당 기능을 실행하고 사용자가 다시 대기 모드로 복귀하기 까지의 전체 스텝을 담는 것’이라고 설명한다.

IBM Checklist에서는 정보의 완전성에 대해 설명하면서 유난히 인터페이스를 통한 사용 정보의 형태와 규격에 대한 언급이 많아서 그 같은 배경에 대해서 생각해 보았다. 최상의 사용법은 매뉴얼이 필요하지 않은 사용법이다. 즉, 특정한 기능을 이해하거나 수행하기 위해 별도의 문서나 사용법을 참고하지 않아도 사용자가 제품의 유저인터페이스를 통해 직관적으로 사용법을 파악하게 하는 것이다. 때문에 많은 제조사들이 사용성이 높은, 직관적으로 이해할 수 있는 인터페이스를 디자인하려고 많은 노력을 기울이고 있다. 버튼 아이콘의 모양이나 위치, 메뉴의 명칭이나 트리의 구조, 제시할 디폴트의 값이나 선택할 수 있는 옵션의 항목 등 관련있는 많은 영역에서 디자이너들은 사용자들을 쉽게 안내할 수 있는 인터페이스를 만들기 위해서 노력하고 핵심 정보를 인터페이스 안에 내장시킨다.

그러나 인터페이스 화면을 통하지 않고도 다수의 조작이 이루어질 수 있는 소비자 가전 제품이나 또는 작은 몸체에 다양한 기능을 담고 있는 제품이라면 인터페이스 화면을 아무리 잘 디자인한다고 해도 모든 정보가 인터페이스를 통해 제공될 수는 없기 때문에 연계되는 매뉴얼이 잘 만들어져야 한다. 이때 매뉴얼을 개발하는 테크니컬 라이터는 체계적이고 완전한 사용법을 안내하는 매뉴얼로서의 정보도 잘 수록해야 하지만 동시에, 인터페이스가 제공하는 정보를 사용자가 쉽게 파악하고 효과적으로 사용할 수 있도록 안내해 주어야 한다.

[Developing Quality Technical Information]에서 표현하고 있는 Completeness에 대한 소개는 다음과 같다: When you know your users and what they are trying to achieve, you can determine both the right information to provide and the right amount to provide. From the user’s point of view, completeness means that all of the required information is available, beginning with the information in any user interfaces. Well-designed user interfaces, which include helpful embedded assistance that follows a pattern of progressive disclosure, can reduce the amount of separate information that users need to achieve their goals. Information is complete when it covers all of the subjects that users need to understand to successfully achieve their goals. Complete information describes subjects at the right level of detail for the audience and the audience’s experience level.

[Developing Quality Technical Information]에 제시되어 있는 정보의 Completeness가 적절하게 수행되고 있는지의 척도를, 실무자들이 조금 더 쉽게 이해할 수 있도록 살짝 가공하면 아래와 같다.

정보의 완전함 점검을 위한 항목들 아래와 같은 부분을 체크해 보세요
사용자 인터페이스 안에도 사용 정보가 내장되어 있어야 한다.
  • 공통적으로 수행하는 작업은 문서를 참고하지 않고도 사용자 인터페이스에서 쉽게 찾고 수행할 수 있도록 되어 있어야 한다.
  • 사용자 인터페이스의 구조와 체계(프로그래밍)는 효과적이고 일관되게 기획되어 있어야 한다.
사용자가 수행해야 할 목표와 대상 주제에 대하여 관련 있는 모든 정보를 설명해야 한다.
  • 제품의 구조나 기계적 사양과 같이 사용 정보와 무관한, 제품의 내부 정보까지 담고 있을 필요가 없다.
  • 인터페이스에 내장되어 있는 사용 정보는 사용자가 특정 기능을 수행하기 위해 꼭 필요한 정보를 담고 있어야 한다.
  • 조작 절차가 아니라 특정 기능의 컨셉에 대한 설명인 경우, 컨셉에 대한 설명이 불필요하게 많을 필요가 없다.
  • 컨셉 설명과 같이 사용자가 특정 기능을 수행하기 위해 직접적으로 필요한 정보가 아니라면 왜 이런 정보를 이해해야 하는지에 대해서 설명할 필요가 있다.
사용자에게 전달하는 정보의 양은 사용자에게 딱 필요한 만큼 제시되어야 한다.
  • 설명에는 적절한 분량의 세부 정보가 포함되어 있어야 한다.
  • 절차나 작업은 지시된 대로 수행하면 정확하게 완료되어야 한다. 중간에 누락되어 있는 절차가 있으면 안된다.
  • 가장 보편적이고 일반적인 사용법을 기준으로 설명해야 한다. 특이한 사용 케이스, 일어날 가능성이 적은 사례를 기준으로 설명의 범위를 넓히지 않아야 한다.
  • 새로운 컨셉을 소개하는 경우라면 충분하게 체계적으로 설명해야 한다.
  • 특정 정보에 대한 시작부 소개글은 대상 독자에 부합되는 수준으로 충분하게 상세하게 제시되고 있다.
사용 정보를 반복해서 설명해도 좋으나 반복 설명이 사용자가 기능 이해, 사용 방법의 패턴을 학습할 수 있다던지 하는 식으로 사용자에게 도움이 되는 경우에 한해서 반복 제시되어야 한다.
  • 사용자가 특정 기능을 계속 수행해야 하거나 상황을 설정하기 위해 중요한 경우에 한해 사용 정보는 반복되어 게시될 수 있다. 이런 경우가 아니라면 정보가 불필요하게 반복되지 않아야 한다.
  • 부가적인 설명을 참고하거나 별도의 지원이 없어도 사용자 인터페이스를 이해하고 사용할 수 있도록 되어 있다.

원문은 아래와 같다.

Guidelines for completeness Items to look for
Make user interface self-documenting
  • Common tasks are easy to find and accomplish in the user interface without documentation.
  • The user interface uses effective and consistent programmatic assistance.
Cover all subjects that support users’ goals and only those subjects
  • Information contains no extraneous topics such as product internals.
  • Embedded assistance and topics cover the information that users need to achieve their goals.
  • The amount of conceptual information is appropriate for the audience.
  • Information that doesn’t directly support a user task includes an explanation for why that information is necessary.
Cover each subject in only as much detail as users need
  • Explanations contain the right amount of detail.
  • Procedures or tasks are complete; no steps are missing.
  • Only the most common uses are described in detail.
  • New concepts are sufficiently developed.
  • Introductory information is sufficiently detailed for the audience.
Repeat information only when users will benefit from it
  • Information is repeated when it is important for the user to stay on task or establish context.
  • Information does not include unnecessary repetition.
  • User interfaces do not require or include unnecessary assistance.

작성자 김양숙 대표