[Developing Quality Technical Information]에서 다루고 있는 두번째 체크리스트는 Accuracy checklist였다. 기술 문서가 얼마나 사용하기 쉬운지(Easy to use)에 기여하는 두번째 요소이기도 하다.
CEO
Accuracy checklist
문서에 수록된 정보의 정확성을 확보하려면, 신중하게, 두 사람 이상의 크로스 체크로, 한차례 이상의 검토를 반복해서 수행하면서 비로소 이루어진다. 기술 문서에 수록된 정보가 기계를 통해 자동으로 생성되는 내용이 아니라 테크니컬 라이터에 의해서 작성되는 내용이기 때문에 휴먼 에러의 잠재를 피하기 힘들기 때문이다.
제대로 걸러지지 않은 채 문서에 포함되어 나가는 정보의 부정확성은 대상 사용자에게 상당한 혼란을 불러일으킨다. 단순하게 문서의 오류로 보는 차원을 벗어나서 제품 자체에 대한 불신으로 이어질 수 있다. 더 치명적으로는 제조판매사를 대상으로 클레임을 제기한다면 여파는 심각해진다. 그래서 테크니컬 라이터에게 수고를 가장 많이 표시해야 할 작업 영역은 정보의 정확성 유지와 관리라는 실로 무겁고 무거운 책임이라는 생각을 자주 하게 된다.
[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가 적절하게 수행되고 있는지의 척도를, 실무자들이 조금 더 쉽게 이해할 수 있도록 살짝 가공하면 아래와 같다.
| 정확성 점검을 위한 항목들 | 아래와 같은 부분을 체크해 보세요 |
| 작성하기 전에 충분히 자료를 수집해라. |
|
| 기술하고 있는 정보가 정확한지 확인해라. |
|
| 기술하는 정보는 항상 최신/최종 정보여야 한다. |
|
| 주제에 관한 정보는 문서의 처음부터 끝까지 일관성을 유지해야 한다. |
|
| 정확성을 체크해 줄 수 있는 도구나장치들이 있다면 최대한 활용해라. |
|
원문은 아래와 같다.
| Guidelines for task orientation | Items to look for |
| Research before you write. |
|
| Verify the information that you write. |
|
| Maintain information currency. |
|
| Maintain consistency in all information about a subject. |
|
| Use tools that automate checking for accuracy. |
|
