Developing Quality Technical Information_3. 수록된 정보가 정확한가

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

문서에 수록된 정보의 정확성을 확보하려면, 신중하게, 두 사람 이상의 크로스 체크로, 한차례 이상의 검토를 반복해서 수행하면서 비로소 이루어진다. 기술 문서에 수록된 정보가 기계를 통해 자동으로 생성되는 내용이 아니라 테크니컬 라이터에 의해서 작성되는 내용이기 때문에 휴먼 에러의 잠재를 피하기 힘들기 때문이다.

제대로 걸러지지 않은 채 문서에 포함되어 나가는 정보의 부정확성은 대상 사용자에게 상당한 혼란을 불러일으킨다. 단순하게 문서의 오류로 보는 차원을 벗어나서 제품 자체에 대한 불신으로 이어질 수 있다. 더 치명적으로는 제조판매사를 대상으로 클레임을 제기한다면 여파는 심각해진다. 그래서 테크니컬 라이터에게 수고를 가장 많이 표시해야 할 작업 영역은 정보의 정확성 유지와 관리라는 실로 무겁고 무거운 책임이라는 생각을 자주 하게 된다.

[Developing Quality Technical Information]에서 표현한 Accuracy checklist에 대한 소개는 다음과 같다: Providing your users with accurate technical information is one of the most important parts of your job. Users expect all of the information that is part of a product to be accurate. If it’s not, they lose confidence with not only the information, but with the entire product. Use the guidelines in this chapter to ensure that your technical information is accurate. Refer to the examples in this chapter for practical applications of these guidelines.

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

정확성 점검을 위한 항목들 아래와 같은 부분을 체크해 보세요
작성하기 전에 충분히 자료를 수집해라.
  • 담아야 할 정보의 범위, 종류 등 사전에 계획을 먼저 수립한다.
  • 전반적인 목차 개요를 수립하고, 다른 토픽 작성시 가이드가 될 수 있는 표준 토픽을 먼저 작성한다.
  • 테크니컬한 정보인 경우 해당 정보에 대한 이해가 높은 전문가를 찾아놓는다.
  • 검증 단계에서 사용할 수 있는 제품, 또는 프로토타입이라도 입수해 둔다.
기술하고 있는 정보가 정확한지 확인해라.
  • 테크니컬한 정보인 경우 해당 분야 전문가를 통해서 내용이 정확하게 기술되고 있는지를 철저하게 점검받아라.
  • 테크니컬한 정보인 경우 테크니컬 라이터가 작성한 정보가 정확한지 해당 기술 책임자가 지적해 주어야 한다.
  • 정보가 정확한지를 체크하는 과정은 제품의 표준 테스트 공정 안에 포함되어 있어야 한다.
기술하는 정보는 항상 최신/최종 정보여야 한다.
  • 제품 설계나 디자인에 변경이 발생한 경우 해당되는 최종 정보가 기술되어야 한다.
  • “새로운” 정보라고 분류해서 표시할 것이 아니다, 모든 새로운 정보가 당연히 기술해야 할 정보 대상이다.
  • 이전 제품에 적용되었던 정보를 그대로 남겨 두지 말고 그 정보가 현재 제품에도 유효한지, 최신 정보인지, 다시 점검하라.
  • 유저인터페이스에 대한 설명이 실제 기기에서 표시되는 인터페이스와 동일한지 체크해라.
  • 조작 중에 표시되는 메시지가 현재 진행하고 있는 절차를 적절하게 반영하고 있는지를 체크해라.
  • 쉽게 구식 정보가 되기 쉬운 날짜를 포함한 정보라든지, 발행에 관련된 식별 정보는 가급적 포함시키지 않도록 해라. 정확성 여부를 체크하지 않고 무심하게 지나치기 쉽다. 만일 포함된 경우라면 정확성을 매번 체크해라.
주제에 관한 정보는 문서의 처음부터 끝까지 일관성을 유지해야 한다.
  • 중복해서 언급되고 있거나 등장하는 정보는 일관된 내용을 담고 있어야 한다.
  • 분리되어 있긴 하지만 관련있는 토픽인 경우 각 토픽에 포함된 내용이 모순된 내용이면 안된다.
정확성을 체크해 줄 수 있는 도구나장치들이 있다면 최대한 활용해라.
  • 예제, 구문 설명, 절차 및 기타 유형의 정보에는 철자 오류가 없어야 한다. 그밖에 부호, 기호, 단위 등에도 오류가 없는지 확인해야 한다. MS워드 등에는 스펠링 오류 등을 체크할 수 있는 자동검색툴이 있으니 최대한 활용해라.
  • 문법적으로 에러가 있는 문장이 남겨져 있지 않도록 체크해라.
  • 관련 정보를 참조할 수 있도록 링크를 삽입해 두었거나 페이지 번호나 토픽 제목을 안내한 경우라면 대상 링크, 대상 페이지에 해당되는 정보가 정확하게 표시되는지 체크해라.

원문은 아래와 같다.

Guidelines for task orientation Items to look for
Research before you write.
  • Information plans are established.
  • Outlines and topic models are written.
  • The appropriate technical experts have been identified.
  • The product or product prototypes are available for evaluation purposes.
Verify the information that you write.
  • The information has been thoroughly reviewed by the appropriate technical experts.
  • Technical owners have indicated that the information is accurate.
  • Information has been validated as part of formal product testing.
Maintain information currency.
  • The final information includes late changes in the product.
  • No information is labeled “new.”
  • Information from previous editions is current and valid.
  • Interface descriptions are consistent with the actual interface.
  • Product messages reflect current product behavior.
  • Information does not include elements that can easily become out of date, such as dates and release identifiers.
Maintain consistency in all information about a subject.
  • Duplicated information is consistent.
  • No conflicts exist between separate but related topics.
Use tools that automate checking for accuracy.
  • Examples, syntax descriptions, procedures, and other types of information are free of spelling error.
  • Text is free of grammatical errors.
  • All links display the intended content.

작성자 김양숙 대표