본문 바로가기

책을읽자

[리뷰] DQTI (5) 2장 Developing quality technical information

1장은 3판을 위한 개요라고 한다면 2장은 전통적인 DQTI를 위한 개요입니다. 하지만 이전 판과는 내용이 좀 다르긴 합니다.

2판(1장)과 3판(2장)의 첫 문장을 비교해 볼까요?

 

(2판)
What is technical information? And how is quality technical information different from just technical information?

 

장 제목 그대로 반영된 첫 문장입니다. 기술 정보가 무엇이고 양질의 기술 정보는 무엇이 다른지 이 책에서 설명하겠다는 내용입니다.

(3판) The evolution in technical information isn’t just about delivery formats. It’s also about refining your ability to write meaningful, quality information.

 

3판에서는 1장에서 설명한 evolution에 좀 더 초점을 맞추고 있습니다. 전달 형식은 변하고 있지만 여전히 양질의 기술 정보를 작성하는 것이 중요하다는 이야기죠.

그래서 2판의 경우에는 기술정보의 품질 특성(실질적인 책 내용)에 대한 개요라면 2판에서는 그 내용이 빠지면서 애매한 설명이 되어버린 것 같습니다. 물론 3판에서는 기존 1장에서 다루는 설명을 1, 2장으로 나누어놓긴 했지만, 전체 내용을 한눈에 볼 수 있는 도식 같은 요소가 빠져 버려서 아쉬운 부분이 있습니다.

2판 - Some quality characteristics require more consideration than others at particular points during the development cycle.



기술 문서를 작성하는 과정을 아래와 같이 3가지 단계로 설명합니다. 하지만, 책에서 (1) 번 단계에 대해서는 따로 언급하지 않았습니다. 이에 대해서는 전문적인 영역이 있으니 관련 책이나 자료를 찾아보라는 의도였는지는 모르겠으나 아쉬운 부분입니다. 어떻게 보면 UX 라이팅이 임베디드 컨텍스트 영역을 차지(?)하게 된 것도 이런 차이가 아닌가 싶습니다. 특히, 이 책이 테크니컬 라이터에게 교과서처럼 받아들여진 점을 생각한다면 그렇다는 겁니다.

(1) Investigating and understanding:

- Users and their skills and knowledge

- Users’ goals, not to be confused with the tasks they do to achieve those goals

- Scenarios for achieving goals

- How the product helps users achieve goals

- Terms and concepts used in the industry

(2) Applying a pattern for progressively disclosing information

(3) Iteratively writing, testing, and editing, using the quality guidelines described in this book

아래 내용처럼 (1) 번에 대해서도 약간 연관된 설명이 있긴 하지만 한 페이지 정도 짧게 다루고 있어서 "Investigating and understanding"을 어떻게 해야 하는지 모호할 수 있습니다.

- The task orientation guideline, “Write for the intended audience” on page 25

- The concreteness guideline, “Consider the skill level and needs of users” on page 220

- The completeness guideline, “Cover each subject in only as much detail as users need” on page 123

728x90
반응형