기록쟁이의 기술 놀이터

문서 개발 프로세스 & 시각 자료 활용

1. 문서 개발 프로세스

1. 초안 작성
2. 동료 리뷰
3. 사용자 피드백 반영
4. 편집 및 최종 검수

2. 체크리스트 기반 품질 점검

• 책에서 QTI 평가 체크리스트 제공 (문서 자가 진단용)

3. 시각 자료 활용 팁

• 복잡한 정보를 표, 목록, 도표 등으로 시각화
• 시각 요소는 설명과 함께 제공해야 효과적
• 인터페이스 스크린샷, 흐름도 등도 포함 가능

독자 중심 문서 작성 전략

1. 독자 중심 접근

• 누가 읽는가? (초보/전문가/개발자 등)
• 무엇을 하려는가? (문제 해결, 설치, 학습 등)

2. 구성 전략

• 목적별 구조화: FAQ, 단계별 가이드, 경고/팁 구분
• 헤드라인, 목차, 색인 활용
• 시나리오 기반 예제 제시

3. 문체 원칙

• 능동태 선호, 모호한 표현 배제
• 문장 당 핵심 1개, 단문 선호
• 표준 용어와 형식 사용

좋은 기술 문서의 9가지 기준

1. 정확성 – 틀림없이 올바른 정보
2. 완전성 – 독자에게 필요한 정보 모두 포함
3. 명확성 – 이해하기 쉬운 표현
4. 간결성 – 불필요한 단어 제거
5. 일관성 – 용어와 표현 통일
6. 유용성 – 독자 상황에 실제 도움
7. 조직화 – 논리적인 정보 흐름
8. 시각적 명료성 – 목록, 표 등 시각 요소 활용
9. 접근성 – 원하는 정보에 쉽게 접근 가능

1. 사용성 

1)  효용성(매뉴얼만으로 제품 사용에 문제가 없는가?) 

2) 편의성(제품 사용에 필요한 정보를 제공하는가?) 

3) 개선 요구(제품 사용을 위해 개선이 필요한가?)

2. 구성 전략

1) 일람성: 문서 번호, 목차, 표/그림 목차, 서문, 매뉴얼 사용 안내, 작동 원리 소개, 절차 진술, 예제, 에러/문제 해결, 용어 정리, 출처 정보, 탐색 기능, 색인, 검색 기능, 페이지 표시 

2) 사용성: 설치 및 제거, GUI 요소 소개, 로그인/아웃, 기능 접근 및 나가기, 조작 수행성, 문제 시 조작 취소 및 재시작, 머리글/바닥글 

3) 목차: 서문과 본문 페이지 표기, 장/절 표기, 장/절 시각 효과, 독자 지향 순서로 구성 

4) 독자 지향 절차: 순서도, 개념 설명, 메뉴 트리, 필요 시 별도 정보 소개, 선행 진술문, 도입부 

5) 제품 사용 사례(Use Case) 

6) 안전 문구 및 참고 사항 

7) 검색성: 검색 진술문, 상호 참조, 목차, 색인, 용어 정의, 온라인 검색 기능

3. 정보 구조

1) 매뉴얼 유형별 취지에 맞는 구조 

2) 취지에 맞는 토픽 구조 

3) 일관된 절차 진술 

4) 절차 진술의 내용: 제목, 준비 정보, 절차 진술, 상세 절차 진술, 조건별 진술, 시각 정보 포함, 절차 완료 진술 

5) 진술의 명확성과 완결성

4. 표기 및 시각 효과

- 가독성과 시인성: 목차/페이지 표시, 일관된 그래픽 규칙, 텍스트와 그래픽 연관성, 태스크의 시각 요소, 일관된 신호어 표현, 표기 규칙, 색상 컨셉

5. 문체 및 어법

1) 일관된 문체 

2) 표기 규정: 괄호, 날짜, 인용부호, 구두법, 수학 연산자, 숫자, 열거, 약어, 화폐, 전화번호, 대시, 폰트, 명칭과 버튼/아이콘 표기, 다단계 메뉴 선택 표기 

3) 철자법 

4) 띄어쓰기

* 해당 콘텐츠는 한겨레 교육 최형선 선생님의 Technical Writing과 기술 번역 강의내용을 토대로 학습 및 기록용으로 작성되었습니다. 모든 강의 내용이 포함되지 않았기에 더 자세한 내용 및 자료를 원하시는 경우 해당 강의 수강을 추천드립니다.

1. 평가자 선정/평가 배점

- 대상 사용자와 동일한 복수의 평가자 선정(3명 이상) 

- 평가자가 5명 이상인 경우 분야별 최고점과 최저점을 제외시킴 

- 중요도에 따라 가중치를 부여할 수 있음 

- 분야별 최고점과 최저점 사이의 격차가 너무 크면 모여서 점수를 조정함

2. 사용성 테스트

- 피험자는 매뉴얼을 읽고 제품을 사용 

- 피험자의 행동을 관찰하고 기록함(비디오 촬영을 하는 경우도 있음) 

- 테스트 종료 후 시간이 걸린 부분, 조작을 잘못한 부분, 조언자에게 도움을 요청한 부분 등에 대해 청취

3. 명료성 평가

- Fog Index 측정: Robert Gunning이 개발 

- 공식: (문장의 평균 단어 수 + 어려운 단어 백분율) x 0.4 

- 이상적인 명료성 수치는 8또는 9 

- 15가 넘어가면 매뉴얼을 다시 작성해야 함

* 해당 콘텐츠는 한겨레 교육 최형선 선생님의 Technical Writing과 기술 번역 강의내용을 토대로 학습 및 기록용으로 작성되었습니다. 모든 강의 내용이 포함되지 않았기에 더 자세한 내용 및 자료를 원하시는 경우 해당 강의 수강을 추천드립니다.

1. 훌륭한 매뉴얼의 특징

- 이해하기 쉽다: 태스크 지향 • 정확성 • 완결성

- 사용하기 쉽다: 명확성 • 구체적(예제 중심) • 훌륭한 스타일

- 검색하기 쉽다: 훌륭한 구성 • 원위치 탐색성 • 시각적 효과

제품 사용성은 매뉴얼 품질에 기인: 매뉴얼 평가 공정이 생겨난 이유

2. 매뉴얼 역할 증대

- 제품 조작 방법의 복잡성 

- 전문 지식 없는 일반 소비자의 증가 

- 혁신적인 기능이나 조작 방법 등장

3. 평가 방법

- 리뷰에 의한 평가: 다시 읽으면서 내용과 실제 제품 기능에 차이가 없는지 확인 

- 사용성 테스트에 의한 평가: 매뉴얼을 읽으면서 제품을 조작해 보는 테스트

* 해당 콘텐츠는 한겨레 교육 최형선 선생님의 Technical Writing과 기술 번역 강의내용을 토대로 학습 및 기록용으로 작성되었습니다. 모든 강의 내용이 포함되지 않았기에 더 자세한 내용 및 자료를 원하시는 경우 해당 강의 수강을 추천드립니다.