Transcript 온라인 도움말의 종류와 제작 방법

전반적인 테크니컬 라이팅에 관한
절차, 진행방법, 세부사항들의 이해
목 차
Part 14: 온라인 도움말의 종류와 제작방법
Part 15: 기술문서 강조하기
Part 11: 효과적인 기획서의 제작
온라인 도움말의 종류와 제작 방법
Ⅰ. 온라인 도움말의 종류와 특징
종 류
User manual
특 징
-온라인 상에 문서 형식으로 도움말을 제공
-인쇄 사용 설명서와 동일한 내용을 구성된 경우도 있고 아닌 경우도 있음
Tutorial
-기초사항에서 복잡한 사항의 사용법을 알려주는 단계별 설명서
-사용자가 스스로 읽고, 피드백을 받고, 실습하는 식의 구성
마법사
(Wizard)
-소프트웨어 프로그램으로 Tutorial 과 유사
-단 Tutorial과의 차이는 Tutorial이 단계별로 진행되는 반면에 Wizard는 사
용자가 선택하여 진행이 가능
안내(지도)
Tip of the day
Pop -up
Context-sensitive
help
-온라인으로 사용자를 감독하고 조언하는 방식(동영상 방식)
-사용자가 프로그램을 실행할 때 메시지 형태로 도움말의 역할
-간결하고 빠른 설명을 위해 특별히 연동이 된 도움말
-화면에 겹쳐 나타나 정보를 알려줌
-버튼이나 하이퍼링크를 클릭하면 주제에 대한 추가정보
-팝업과 달리 다른 화면으로 이동하여 정보를 알려줌
Ⅱ. 시작하기
1. “시작하기”의 필수 항목
- Tutorial과 Wizard
- 프로그램이나 어플리케이션의 설명
- 어플리케이션을 사용하기 전에 사용자가 필요한 것
- 사용자가 원하는 결과를 얻기 위해 해야 할 작업
- 사용자가 실행한 결과의 의미
2. “시작하기”의 사용자 고려
- 인터넷에 대하여 이해하고 있는가?
- 최신 브라우저를 가지고 있는가?
- (그렇다면) 인터넷 연결 방법을 알고 있는가?
- URL의 사용법을 알고 있는가?
Ⅳ. 개발 진행 순서
1.정의
2.모델
3.계획
4.개발
5.테스트
6.발표
7.유지
- 시작부터 자료 출력까지의 제품주기를 정의
- Technical Brief를 이용하여 사용자를 파악
ⅰ. 인사, 재무, 영업 등 다른 부서의 도움 요청
1.정의
2.모델
- 설계의 체계를 이해
3.계획
4.개발
5.테스트
6.발표
7.유지
ⅰ. 설계에 필요한 프로그램에 대한 지식과 방
법
- 파일명, 하이퍼링크, 그래픽 등의 확인
1.정의
2.모델
3.계획
- 서식과 스타일 가이드를 제작
- 파일 시스템과 파일 구조를 설계
4.개발
5.테스트
6.발표
7.유지
1.정의
2.모델
3.계획
- 적합한 그래픽, 음성, 비디오, 애니메이션, 음
악 등의 개발과 조직화
4.개발
5.테스트
6.발표
7.유지
1.정의
2.모델
3.계획
4.개발
- 다른 컴퓨터, 플랫폼, 작동 시스템에 대한 테스
트 실시
- 수정/개선 후 2차, 3차 테스트 실시
5.테스트
6.발표
7.유지
1.정의
2.모델
3.계획
4.개발
5.테스트
6.발표
7.유지
- 완제품의 출시하기 전에 전반적인 검토 후 편
집/양산
1.정의
2.모델
- 피드백의 요청
3.계획
4.개발
5.테스트
6.발표
7.유지
- 사이트 개설 후 사이트에 대한 지속적 정보제
공
- 달성된 부분과 미진한 부분의 평가
Ⅲ. 유의사항
1.프로그램의 개발과 함께 온라인 도움말도 지속적으로 수정, 보완 필요
2. 사용자를 위한 절차의 간편화가 중요
1) 한 번에 한 장(章)씩: 한 장(章)을 구성하여 시험하고 피드백을 받음
2) 스타일 가이드 제작: 글꼴, 레이아웃, 약어, 기호 등의 통일성 유지
3) 정확한 사이트 맵의 구성
제품 정보
예제:
온라인 도움말





[홈페이지]
제목(회사명)

제품 정보


교육훈련 정보
라이브러리
영업 브로셔
제품지원 사양
제품 가격
PL 안내
관련 기사
교육 훈련 정보



튜토리얼
(동영상 자료)
제품의 실연
세미나 안내
라이브러리
사용자 매뉴얼
저작권 표시
목차
빠른 참조
[P] print
[S] save
설치 안내서
단계
1
2
행동
구성물 확인
배터리 사용
문제해결하기
Q1. 인터넷 연결
“버튼”




사용자 매뉴얼
빠른 참조
설치 안내서
문제해결하기
A1. 케이블 확인
A2. 모뎀 전원 확인
기술 문서 강조 하기
Ⅰ. 기술문서 강조의 5요소
타인의 감수 철저한 감수
독자의 눈길
사로잡기
시각효과
(어필하기)
살 붙이기
전체적 틀 형성
골격 제작
(개요)
사용자 욕구 파악 사용자 이해
효과적인 기획서 제작
Ⅰ. 기획서에 포함될 10가지 항목
기획서
1. 표지
6. 프로젝트 묘사
2. 목차
7. 소요 예산 제시
3. 초록(개관)
8. 결론
4. 도입
9. 부록
5. 기획의 필요성 제시
10. 용어집
Ⅱ. 구성 항목 별 세부사항
1. 표지
- 작성자, 제목, 주소, 연락처, 날짜 등의 사항을 포함
- 속지보다 딱딱한 재질의 고급 종이를 사용
- 속지에서 1~2가지의 적당한 색상 선정
2. 목차
☞ 15 페이지가 이상일 때: 목차를 이용, 정보 검색을 용이하도록 함
(참고: 5~8분이 읽기의 한계 = 약 15페이지)
- 부제를 두어 사용자가 더욱 정확한 정보 검색이 가능하도록 함
- 항목에 따른 페이지 번호도 함께 작성
Ⅱ. 구성 항목 별 세부사항
3. 초록(개관)
- 문제, 필요에 따른 간결한 진술
- 프로젝트의 설명
“핵심내용만 기재”
- 필요한 총 자금 지적
4. 도입
- “개념” : 전반적인 진행 방향과 목적, 목표 제시
- “프로그램” : 목표 달성을 위한 간략한 진행 계획의 나열
- “재무” : 예상 결과 산출까지의 필요한 비용 제시
Ⅱ. 구성 항목 별 세부사항
5. 필요성 제시
- 발생한 문제, 혁신방안 등의 필요성 열거
- 설득을 위한 객관적인 근거 제시
6. 프로젝트 묘사
- 프로젝트를 뒷받침하는 통계자료 제시(수치화)
- 낙관적이고 열정적인 어조를 통한 자신감 어필
- 기존의 방안이나 프로세스와의 차이점과 효용을 최대한 부각
- 실행 시 다른 분야의 파급효과까지 예측하여 제시
Ⅱ. 구성 항목 별 세부사항
7. 소요 예산 예측
- 세부 비용과 총비용을 한 페이지 이내로 작성
(참고: 심리학적으로 비용에 대한 장황한 설명이 설득력을 저하)
- 표와 그래프를 이용하여 시각적으로 제시
8. 결론
- 한 개 혹은 두 개의 문단으로 결론을 구성
- 작성자의 앞으로의 활동을 간단히 기재
- 프로젝트의 유지와 방향을 간략히 제시
Ⅱ. 구성 항목 별 세부사항
9. 부록
- 프로젝트와 관련된 사람들의 약력
- 프로젝트를 지지할 수 있는 추천서와 표, 그래프 등의 삽화 자료
10. 용어집
- “A~Z” 혹은 “ㄱ~ㅎ” 순서로 용어를 나열
- 항목에 따른 페이지 번호도 함께 작성