2024. 10. 4. 12:07ㆍ테크니컬라이팅
"우리 회사에서 새로운 제품을 출시하려고 하는데, 사용자 가이드를 새롭게 제작하고 싶다."라는 요청을 받았다고 하자. 그러면 이러한 질문들을 기반으로 상대와 논의를 진행해야 한다.
"What is the product (어떤 제품인지)?"
"Who are the usrs (누가 사용하는건지)?
"What does an information concept consist of (제품 개념 설명에는 무슨 내용을 넣어야 하는지)?"
그런데 고객 또는 Product Manager와 이야기할 때마다 그들이 요청하는 결과물의 이름이 바뀐다. '사용자 가이드', '유저 매뉴얼', '제품 사용 설명서', '매뉴얼 콘텐츠', 등 여러 이름으로 불린다. 사용자의 이해를 돕고 가이드하는 콘텐츠의 최종 형태가 무엇이건 이들을 총칭하는 용어가 있다.
바로 "information product (정보 제품)"이다.
'정보 제품'이라 표현하니 선뜻 느낌이 오지 않을 수도 있지만, 정보를 전달하는 목적을 가진 제품을 총칭한다고 이해하면 쉽다. 제품에 대한 설명이 종이 위의 텍스트로 표현되어 있는 경우, 웹에 기재되어 있는 경우, 아니면 동영상의 형태로 표현된 경우 모두 다 'information product'이다.
기술 문서 작성 프로세스와 정보 아키텍처링에 대한 전문가가 드문 우리나라에서는 생소한 표현이지만, 테크니컬라이팅이 발달한 독일에서는 이들을 명명하고 정의하고 표준화하려는 노력이 오랜 기간 누적되어 있다. 테크니컬 커뮤니케이션 업계에서 유명한 Roland Schmeling 교수가 Information Product에 대해 내린 정의를 보자면 다음과 같다.
"An information product is a delimited amount of information that is presented in such a way that leaving it can easily be perceived. (해석: Information Product란 특정한 범위의 정보를 기술한 정보의 집합으로서 사용자의 이해를 돕기 위해 만들어진 제품을 의미한다.)"
달리 말하자면, 정보 제품이란 정보가 될만한 여러 데이터 중 사용자가 받아들일 수 있는 범위의 내용만을 모아 사용자가 이해하기 쉽게 모아 놓은 정보 덩어리를 의미한다.
참고로, delimitate는 "-의 한계를 정하다. -을 명확히 기술하다"라는 뜻의 동사이다.
'Information Product'가 무엇인지 이해했으니, 이제 이 정보 제품에는 어떤 종류 (Information Type)가 있는지 살펴보자.
Information Type
정보 유형(information type)은 '콘텐츠'와 '의사소통 기능', 두 가지로 구분한다. 다양한 정보 유형을 일일이 구분 짓기는 쉽지 않기에 그때그때 맥락과 상황에 따라 정의해야 한다. 예를 들어, 한 웹사이트 내에서 다른 스타일로 매 페이지를 설계하는 경우 동일한 내용의 콘텐츠라도 각각의 페이지 스타일과 디자인에 따라 이들은 다른 '정보 유형'이 된다.
구분 1. DITA에서 나누는 구분
가장 잘 알려진 XML기반의 정보 구조화 표준인 DITA는 정보 유형을 아래와 같이 세 영역으로 구분한다. DITA에 대해서는 다른 글에서 더 상세히 다룰 예정이므로, 여기서는 DITA가 기준으로 삼는 정보의 세 가지 유형이 있음을 언급만 하고 넘어간다.
- Description : 개념 설명 (예시, 제품의 사용 목적, 특정 컴포넌트의 개념 설명 등)
- Task : 유저에게 요구하는 액션들 (예시, 유지보수 작업 순서, 조립 작업 순서 등)
- Reference : 참고 자료 (예시, 파라미터 레퍼런스, 용어집 등)
혹시 DITA가 궁금하신 분은 https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture를 미리 참고하시면 된다.
구분 2 : 내부 문서인가 외부 문서 인가?
작성하는 정보 제품이 내부용인지 아니면 외부 배포용인지에 따른 구분이다.
내부 문서 : 사내에서 직원들 간에 정보 공유와 전달을 위한 문서이다. 보통 아래와 같이 구분한다.
- Requirement Documentation (요구사항 문서) :각종 법규, 회사 규정 관련 문서
- Design Documentation (설계 문서) : BOM파일, 도면, 테스트 리포트, 제품 데이터, 제품 사양, 기능 정의서 등
- Safety Documentation (안전 문서) : Risk assessment 문서
- Approval Documentation (승인 문서) : 인증, 품질 관련 문서
- Product Observation Documentation (제품 문서) : market reports, damage reports and analysis 등
- Service Documentation (서비스 문서) : 제조사의 서비스 담당자를 위한 매뉴얼 등
외부 문서 : 외부 고객이나 파트너에게 공유하기 위한 문서이다. 판매 이전의 문서 (pre-sales docs)인가 판매 이후의 문서(after-sales docs)인지를 구분한다.
- pre-sales docs: 제품의 가치를 고객에게 알리고 올바른 제품을 선택할 수 있게 가이드를 주는 정보로서, 제품 카탈로그, 제품 데이터 시트, 가격 리스트, 서비스 설명서 등에 해당한다.
- after-sales docs: 제품을 구매한 고객에게 제품의 안전하고 올바른 사용을 위해 제공되는 정보로서, 제품 배송 및 설치 안내, 사용 방법 안내, 유지보수 문서, 진단과 트러블슈팅 가이드, 스페어 파츠 카탈로그, 고객 의견 전달서, 경고 라벨 등이 이에 해당한다.
참고로, 대부분의 기술 문서는 외부 문서 개발을 염두에 두고 작성된다. 그렇기 때문에 '정보 제품' 작성을 의뢰를 받았을 때 테크니컬라이터는 이러한 내부 문서에 들어가는 정보를 요구하고 알고 있어야 한다.
구분 3: 어떤 기능을 하는 문서인가? (=무슨 목적의 문서인가?)
어떤 목적을 위해 만들어진 정보 제품인가에 따른 구분이다. 보통 아래와 같이 7개의 분류로 나뉜다.
- Didactic function : 교육 자료, 기능 설명, 운영 매뉴얼 등
- Safety function : 올바른 사용법, safety brochures, warnning message 등
- Orientation function : 컨트롤 화면, 스크린 설명 등
- Maintenance function : 테스트 방법, 유지보수 계획, 체크 리스트, 부품 교체 방법 등
- First aid function : 트러블슈팅 표, 진단 프로그램 사용법 등
- Reference function : 테크니컬 데이터, 스페어 파트 카탈로그, 툴 테이블 등
- Logistic function : 제품의 배송 및 보관 방법 등 (하드웨어가 존재하는 제품에 한함)
한 콘텐츠가 하나의 목적만을 가질 수도 있고, 두 개 이상의 목적을 가질 수도 있다. 예를 들어 어떤 문서가 소프트웨어의 목적과 기능에 대한 설명을 하면서 동시에 이 제품의 테크니컬한 스펙을 함께 안내하고 있다면, 이는 didactic (설명적) 기능과 reference (참고 자료) 기능을 동시에 제공하는 것이다.
지금까지 information product이란 무엇이며, information product의 유형에 대해서 살펴보았다.
다음 글은 소프트웨어 다큐멘테이션에 대해서 살펴볼 예정이다.
'테크니컬라이팅' 카테고리의 다른 글
| Write the docs : 기술 문서 관심있는 사람들 모여라 (0) | 2024.09.30 |
|---|