유형별 테크니컬 라이팅 작성의 원칙

1. 메일

1-1. 독자가 궁금해할 내용을 작성하자.

안녕하세요. 제품화팀 나길동입니다.
번역 품질을 높이고 번역 시간을 단축하기 위해 번역 툴을 구매하고자 합니다. 

구매하고자 하는 툴은 AutoSuperTran이며, 가격은 50만 원입니다.
그럼 확인 부탁드립니다.
감사합니다.
김종훈 드림.

다음 메일에서 나올법한 질문은?

- AutoSuperTran을 사면 어떤 점이 나아지는가?
- 번역 속도가 얼마나 빨라지는가?
- 번역 품질이 높아지는가?
- 비교 대상이 된 툴에는 어떤 것이 잇나?
- 각 툴의 장단점은 무엇인가?
등등 독자가 궁금해할 내용을 모두 메일에 포함해야 합니다.

1-1. 인사말과 맺음말은 과하지도 부족하지도 않게 쓴다.

 ex) 안녕하세요. 00 그룹 00 개발000입니다. 추운 날씨에 잘 지내고 계신지요.
>>> 안녕하세요. 00 개발팀 000입니다. 연휴는 잘 보내셨는지요.

맺음말은 회사 팀 - 부서 - 외부 순으로 간단 - 명확하게 작성한다.

00팀 김종훈 드림 
--
00팀 김종훈 사원
휴대폰 : 010-0000-0000
전화 : 02-000-0000
--
김종훈 사원
개발팀
00 회사

회사 위치
휴대폰 : 010-0000-0000
전화 : 02-000-0000
이메일 : ~~~~
--

1-2. 받는 사람을 명확하게 지정한다.
To) 메일 내용을 반드시 알아야 할 사람, 메일을 받고 업무를 진행해야 하는 사람.
Cc) 메일 내용을 알아두면 좋은 사람, 관련있는 사람.
Bcc) 메일 내용을 알아두면 좋지만, 굳이 존재를 알리거나 메일 주소를 알릴 필요가 없는 사람

1-3. 첨부 파일
첨부 파일 이름만으로 내용을 짐작할 수 있게 작성.
필요한 내용만을 첨부 파일로 만들어 보내기.

 

 

2. 회의록

2-1. 회의록 구성 요소

회의한 일시, 참석자, 불참자와 사유, 회의 내용, 회의 결과와 담당자, 회의록 작성자, 회의 안건, 안건별 결정 사항, 안건별 담당자, 안건 완료 예상일, 다음 회의와 준비 사항 예고

2-2. 회의록 작성 원칙

1. 미리 회의 안건을 공유한다.
2. 안건별로 담당자와 일정을 정한다.
3. 회의 직후에 정리한다.
4. 회의록에는 요점만 정리한다.
5. 중립 어조를 지킨다.
6. 작성 후 검토한다.
7. 일정 공간에 배포한다.

2-3. 회의록 예시

 

 

4. 사용자 가이드

목적에 따라 퀵스타트 가이드, 사용법 가이드, 레퍼런스 가이드 등으로 세분화 할 수 있다.

1. 사용자 가이드에 있어야 할 항목

1. 사용자가 제품을 사용해 할 수 있는 일
2. 제품을 사용하기 위해 알아야 할 사전 지식이나 참고 사항
3. 업무별 사용 방법
4. 실제 사용 예와 샘플 코드
5. 추가 내용을 학습할 수 있는 참고 사이트
6. 내용을 효율적으로 전달할 수 있는 스크린샷, 다이어그램, 차트 등

2. 개념과 목적을 설명하는 개요를 추가한다.

• 개요의 필요성
  사용자마다 알고 있는 사전 지식이 다르기 때문에 제품의 정의와 용도를 먼저 알려 주는 '개요'가 있어야 한다.
  개요에는 서비스 전체를 아우르는 개념과 시스템 구성 등을 소개해야 하므로 서비스 전체를 충분히 알고 있는 사람이 작성해야 합니다.
• 문서 개요
  문서에서 어떤 내용을 다룰지 소개
• 서비스 개요
  문서에서 다루는 서비스가 무엇인지 소개

3. 문서 개요 작성

• 포함해야할 내용
  문서 정의, 문서 목표, 문서 독자,문서 변경 이력, 문서에서 사용한 특정 스타일 소개, 문서 내용 관련 문의처, 문서 저작권

4. 서비스 개요

• 포함해야할 내용
  무슨 서비스인지, 어디에 사용하면 되는지, 주요 기능이나 특징

5. 사용법은 순차적으로 설명한다.

• 기능이 많고 복잡한 서비스라면 한 사람이 모든 기능을 자세히 알기 어려울 수 있습니다. 따라서 여러 사람이 나눠 작성할 때가 많습니다. 각 기능을 가장 잘 알고 있는 사람이 작성해야 하며, 여러 사람이 나눠 작성해도 어조나 설명 방식을 통일할 수 있게 작성 스타일을 미리 맞춰 놓아야 합니다.

 

5. 퀵스타트 가이드

퀵스타트 가이드는 제품이나 서비스를 처음 접하는 사람이 빠르게 기능을 익힐 수 있게 만든 짧은 문서입니다.
꼭 필요한 기본 정보와 주요 사용법을 그림과 함께 설명합니다. 얇은 책자, 한 페이지 요약본, 비디오 가이드 등 다양한 형태로 제작이 가능합니다.

1. 작성법

• 빠르게 결과를 확인할 수 있게 합니다. 
  ex) Hello world
• 복잡한 개념이나 구조 설명을 생략
• 내용은 물론이고 용어도 쉽게 풀어 써야함.
• 초보자에게 문서를 보여주고 어려운 설명이 없는지, 부족한 내용이 없는지 테스트해야함.