Transcript 2. 제본 방법

전반적인 테크니컬 라이팅에 관한
절차, 진행방법, 세부사항들의 이해
목 차
Part 9: 사용자 매뉴얼 작성의 이해와 진행방법
Part 10: 요약문 작성을 통한 효과적 접근 방법
Part 11: Spec Sheet의 단계별 작성법
Part 12: 질의서의 종류와 작성법
Part 13: 프레젠테이션의 주의사항과 핵심 이해
Part 14: 개요(요약)의 중요성
사용자 매뉴얼 작성의 이해와 진행방법
Ⅰ. 매뉴얼의 종류
◎ Tutorial: 자가 학습용 안내서로 사용
◎ Training manual: 기본적이고 전반적인 학습용 주 교재로 사용
◎ Operator’s manual: 설치/운영 사용자들을 위해 사용
◎ Service manual: 기계 수리를 위해 사용
◎ Maintenance manual: 기술자들의 유지/관리를 위해 사용
◎ Repair manual: 전반적 수리를 담당하는 서비스 기술자를 위해
사용
Ⅱ. 매뉴얼 제작의 계획 단계
1
프로젝트의 범위와 목표 설정
2
개발방법의 모색
3
기본 규칙의 정립
4
역할분담과 일정표 작성
5
정리(문서화)
Ⅲ. 독자에 대한 이해
1.
전달 방식에 따른 특징
방식
인쇄
전자매체
혼합형
(인쇄+전자매체)
사용의 예
현장에서 장비를 사용하는 사용자에게 적합
(현장에서는 컴퓨터에 접근할 기회가 없기 때문)
컴퓨터 응용이 가능한 독자에게 적합
초기: 인쇄된 사용 설명서를 이용하여 기초적/전반적인 설명
중.후기: 실사용 중 필요한 부분에 대한 이해를 돕기 위해 전자
매체 설명서가 사용
2. 포장에 내용물 정보 표기의 중요성
내용물을 목록, 그림, 사진 등으로 설명
구매자에게 제품에 대한 사전 정보 제공
제품에 대한 신뢰도와 좋은 이미지 전달
Ⅳ. 정보의 분류, 나열순서
1. 매뉴얼의 내용 검색 도우미
1) 목차
-15페이지 이상의 경우 목차를 작성하여 전반적인 내용 파악을 도움
2) 용어해설(용어사전)
-설명서 끝부분에 용어해설을 실어 독자의 궁금증을 해결하도록 함
3) 색인
-사용자의 입장에서 필요한 경우 사용, 정확한 색인방법도 함께 기재
4) 문제 해결하기(Frequent Asked Questions: FAQs)
-발생 문제에 대한 원인들과 그에 맞는 해결 방안을 제시하는 형식
-초판일 경우 테스터들이 시험기간 동안 찾아낸 질문들 위주로 작성
-2~3판일 경우 헬프 데스크에 들어온 질문들을 위주로 작성
5) 사용 후기 조사 양식(Feedback form)
-사용후기에 대한 설문조사를 통해 문제 해결 및 개선
2. 제본 방법
제본 종류
방법
Loose-leaf binder
-1년에 1회 이상 업데이트가 필요한 100페이지 이상의
문서일 경우에 사용
-2~3개의 고리를 이용하여 내용의 추가/삭제가 쉬움
Perfect binder
-일반적 책의 형태로 접착제만으로 모든 페이지가 결합
-단점은 페이지를 펴놓고 작업을 하기 힘듦
-문서 중앙에 스테이플 핀을 이용하여 결합된 문서
Saddle binder
-100페이지 이하의 경우 가장 효율적인 제본방법
(Stapled in the spine)
- ^ (; saddle)과 모양이 비슷하여 이름이 붙여짐
Spiral binder
-플라스틱이나 철로 된 스프링을 이용하여 결합된 문서
-100페이지 미만의 경우에 사용되는 고가의 제본방법
-장점은 쉽게 필요한 부분을 펴고 볼 수 있음
요약문 작성을 통한 효과적 접근 방법
Ⅰ. 초록(抄錄)의 이해
1. 초록(요약문,개요)의 종류
: 작성자가 전하고자 하는 정보의 종류에 따라
기술적 초록
- 3~4개의 문장들로 이루어진 약식의 요약문
- 목차를 문장으로 서술한 느낌
- 문장으로 핵심을 나열하고 소개하는 방식
정보적 초록
- 문서의 중점사항을, 200~250개의 단어를 사용하여 제공
- 초록만을 따로 배치하거나 도입부에 함께 배치
- 주제, 범위, 목적/ 사용방법/ 결과/ 추천 등의 내용을 실음
Ⅱ. 효과적인 초록 사용의 예
1. 신제품, 서비스의 출시를 알리기 위해 박람회, 세미나, 컨퍼런스에서 배포할 경우
2. 사내/외부의 관리자급의 관계자에게 간결한 형식으로 초록을 제시하는 경우
3. 전문 잡지와 신문 등을 이용하여 홍보 목적으로 사용하는 경우
압축된 내용 전달
관심 유발
빠른 이해
시간 절약
Spec Sheet의 단계별 작성법
Ⅰ. 사양서(Spec Sheet) 작성절차와 방법
단계
▷ 1단계 : 요구사항 Specs
1) 제품이나 어플리케이션의 정의
요구사항
기능
설계
시험
최종
2) 제품/ 어플리케이션의 기능과 능력의 목록 작성
3) 완제품의 사전 비용 평가
단계
▷ 2단계 : 기능 Specs
1) 시스템 검토: 주제, 기능, 방법, 작동, 결과 등 설명
요구사항
2) 자료일람표: 자료명, 기호, 자료소스, 자료정의, 자료분석, 코드 등
자료의 수치 작성
기능
3) 입력설명: ① 시스템 내부의 자료와 입력 방법을 설명
② 주안점은 사용자 편의를 위해 알기 쉽게 작성
설계
4) 작동설명: 특정 조건하에 시스템의 기능과 결과를 설명
시험
5) 계산: 시스템의 결론 도출 방식을 설명
6) 파일설명: 자료 파일의 목적, 내용, 사용법, 구조 설명
최종
7) 특이사항 첨부: 제품의 고유한 기능이나 특성을 설명
단계
▷ 3단계 : 설계 Specs
1) 관련 문서 첨부: 제품에 관련된 정보를 첨부
요구사항
2) 기능 설명: 언어, 도표를 이용하여 자세하게 기능 설명
3) 인터페이스: 사용 전력과 같은 제품의 인터페이스를 논의
기능
4) 소프트웨어 고려: 프로그래밍과 관련된 기능적 측면 고려
설계
5) 신뢰도 검사: 제품의 서비스, 유지, 보수에 관한 신뢰도 측정
6) 문제점 진단: 품질보증을 위한 시험 및 평가 방법의 개발
시험
최종
7) 변경사항: 작업진행에 필요한 변화를 모색, 묘사
단계
▷ 4단계 : 시험 Specs
1) 관련 문서 첨부: 이전에 개발된 유사 제품과 관련된 정보를 첨부
요구사항
기능
설계
시험
최종
2) 제품 설명(묘사): 테스트에 합격한 항목과 불합격한 항목을 확인
3) 테스트 방법: 실험과정의 단계별 묘사 (진행절차/문제기록)
4) 예방책: 실험과 관련된 주의사항과 문제 확인
단계
▷ 5단계 : 최종 사용자 Specs
1.
1) 제품과 함께 동봉되어 있는 제품설명서 (완성본)
요구사항
2) 제품의 강.약점, 특성, 기능, 지원 사양 등의 정보가 포함
3) 사용자에게 제품 작동에 관한 정보를 제공
기능
설계
시험
최종
질의서의 종류와 작성법
Ⅰ. 질의서의 종류와 작성법
1. 질의서(평가서, 설문지)의 종류와 특성
1:1 질의서
서신/웹 질의서
-면접관의 표정, 억양에 영향을 받지
장 -세밀하고 밀도 있는 정보 수집이 가능 않는 답변을 얻을 수 있음
점 (일반적으로 대화를 이용)
- 면접자의 질문 주제에 대한
적극적 답변을 얻을 수 있음
-공간과 면접인원 수의 제한
단
점 -사용자의 대표성이 떨어짐
-주제와 적합한 질문/답변의 도출이
안될 가능성 있음
2. 작성방법
- 올바른 맞춤법과 정확한 표현
- 작성자의 소개, 질의서의 목적, 사용방법을 기재
- 정확한 회답 기일을 알림
- 회답률을 높이기 위해 우표, 반신용 봉투 동봉
Ⅱ. 질의서 작성할 때 주의사항
1) 질의서의 시작에서 응답자의 이점을 알려 응답률을 높임
2) 명확한 질문 항목 작성
3) 응답자가 질의서를 시작할 때 쉽게 접근/이해할 수 있는 순서로 배열
4) 동일 주제에 대한 항목의 그룹화 ; 질의서의 통계/분석이 용이
5) 기타 응답을 위한 공간 마련
6) 응답자의 개인 정보 비밀 엄수
7) 질의서의 회수 방법 지시
Ⅲ. 질문의 종류와 선택
1) Closed-Ended Questions (폐쇄형 질문)
① “예. 아니요. 모름”의 보기
-응답자에게 예, 아니요, 모름의 보기를 주고 질문하여 선택하게 함
② Multiple Choice (다지 선다형 보기)
-4지선다형, 5지선다형의 번호가 매겨진 보기를 제시 (기타항목 필수)
③ Sliding Scale
-매우 좋음, 좋음, 보통, 나쁨, 매우 나쁨 형식의 보기를 제시
※ 주의: 보기에 번호가 매겨진 경우 번호에 따른 선호 수준 설명
겹쳐지는 범위의 사용(ex; 1-10, 10-20, 20-30) 주의
2) Open-ended Questions (개방형 질문)
- 세분화된 항목의 질문을 제시하거나 혹은 전반적인 의견을 질문하는 형식
- 응답자 본인의 생각을 글로 작성
① 장점
; Face to face Questions와 유사하게 심도 있고, 세밀한 정보 획득 용이
② 단점
; 응답의 시간이 많이 걸려 응답률과 회수율이 낮음
질의서의 통계/분석에 시간이 많이 걸려 제약
프레젠테이션의 주의사항과 핵심 이해
Ⅰ. 청중에 대한 정의와 접근
1. 청중에 대한 이해 항목
•
청중은 당신에 대해 무엇을 알고 싶어하는가?
•
청중은 당신의 주제에 대해 무엇을 알고 싶어하는가?
•
어떤 동기부여를 통해 발표회에 참석하게 할 것인가?
•
청중에게 핵심사항은 무엇인가?
Ⅱ. 프레젠테이션을 위한 3가지 핵심 준비 사항
1. 연습은 실전과 같이!
-말하기와 시선처리에 대한 연습
-말하기의 핵심2. 지정된 시간 안에!
-8페이지 읽기는 대략 15분 소요/
시간확인 습관 필요
3. 발표 장소 준비!
-발표에 방해되는 요소의 제거
오디오. 비디오 시스템의 점검
1) 단어나 문장의 반복으로 강조
2) 불필요한 문장의 생략
3) 어조의 강약 조절, 휴지(休止)사용
Ⅲ. 시각/영상 지원 도구의 종류와 특성
방법
장점
단점
칠판
비공식적/ 저렴한 가격/ 쉽게 구함
낮은 시각적 효과/ 지루함/ 제한된
청중 수
20명 미만이 적정/ 쉽게 구함/
싸고 비공식적/ 청중간의 의견교
환이 쉬움
낮은 시각적 효과/ 주의력을 떨어
뜨릴 수 있음
Flip chart
(궤도)
Transparency 75~100명 적정/ 융통성이 있고
(=Overhead, 청중과의 의견 교환이 쉬움/ 준비
하는 기간이 짧음/ 저가
O.H.P)
슬라이드
비디오
수백 명이 수용 가능/ 공식적/
Transparency보다 높은 질/ 프로
젝터의 운반이 용이/ 사진의 복사
가 쉬움
프로젝터가 청중의 시야 방해/
사진의 질이 떨어짐/
고가/ 어두운 회의실로 인해 청중
간의 의견교환이 어려움/
최대 인원 수용이 가능/ 가장 높은 청중이 화자가 아닌 비디오만 집
시각효과 창출/ 몰입도가 높음/ 가 중하는 경우 발생/ 최고가/ 장시간
장 공식적
의 준비가 필요
Ⅳ. 발표자료의 제공
1) 발표 전 자료 인쇄물 제공하는 방법
- 청중에게 사전 정보를 제공함으로써 화자의 의도를 따르게 하는 교육훈련에 적합
- 단점으로는 발표 내용을 미리 알게 되어 집중력이 떨어짐
2) 발표 후 자료 인쇄물 제공하는 방법
- 발표 내용과 중복되는 내용, 근거, 예시 등이 실려 있는 경우에 적합
- 단점은 사전 지식이 없어 질문 할 기회가 없고, 확인하지 않고 버리는 경우가 발생
개요(요약)의 중요성
Ⅰ. Executive Summary의 중요성
1. 관리자들의 문서 구성요소 확인 확률
부록(Appendix)
15%
본문(Body)
22%
결론(Conclusions)
55%
도입(Introduction)
65%
개요(Executive
Summary)
100%
0%
20%
40%
60%
80%
100%
Ⅱ. 효과와 구성요소
1) 시각적 효과
: 전체적인 내용을 한 눈에 볼 수 있도록 함
(가장 먼저 확인하는 항목으로 사람의 첫 인상과 같은 역할)
2) 필수 구성 요소와 배열 순서
배열순서
“긍정적” 독자
구
성
요
소
“부정적” 독자
1번
목적
목적
2번
장점과 조사결과
배경정보
3번
분석과 증거자료
분석과 증거자료
4번
배경정보
단점과 조사결과