Page Comparison

1

• 테크니컬 라이팅은 영어에서 시작됐다.

• 테크티컬 라이터는 창작을 하지 말아야 한다.

• Usage! 때론 문법보다도 사용성이 중요하다.

2

테크니컬 라이팅과 스타일

"텍스트는 그림처럼 보여야 하고 그래픽은 말을 해주어야 한다." → 유형별 스타일(제목, 단계, 노트 등의 서식)

문법보다 사용성이 중요

• 예1) 전치사로 끝나는 문장 허용
  Check the file to which the column links. → Check the file that the column links to.

• 예2) 부사를 동사 앞에 위치 (to + 동사원형 고집X)
  To estimate the cost of the repairs thoroughly, → To thoroughly estimate …

TW 5원칙

1. Correct(정확성)

2. Clear(명확성)

3. Consistent(일관성) - 사용성 고려, 용어집, 스타일 가이드

4. Compact(간결성)

5. Complete(완성도) - 글의 전체적 요소를 모두 포함한다.

3

스타일가이드

한글의 구두법, 띄어쓰기 사용 유래
→ 호머 헐버트 선교사가 주시경 선생님께 전달하여 사용됨

복수 메뉴를 선택하는 경우: Bold체와 ‘>’ 사용
예) 워크플로우 > 실행 내역 화면에서 실행결과서 버튼을 클릭합니다.

내용 나열
예1) “a,” “b,” and “c.” (미국식)
예2) ‘a’, ‘b’ and ‘c’. (영국식)
예3) ‘a’, ‘b’ 및 ‘c.’ (한국식)

한정적인 표현 → that 사용
예) A that is the first character. (A, which is the first character.)

대시

• 엠(Em)대시: a—the first character of the alphabet

• 엔(En)대시: 1~5 → 1–5 (특수 기호에 있음)

• 하이픈: real-time (복합어 사이에 사용)

가정법 (When 사용)
예) If you click A, B will be displayed.
→ When you click A, B appears.

절차나 목록 소개 도입문 뒤에 콜론 사용
예) To install the program:
1. Click A.
2. Click B.

경로 표시 줄 바꾸기
예) C:\Documents and Settings\
Administrator

1이 아니면 복수
예) 0 degrees. 0.2 degrees

특수 기호 명칭과 표기 용례
: &(ampersand), @(at sign), #(미국 pound sign, 영국 hash sign), / (forward slash), <> (angle bracket)

예1) A menu item with … → A menu item with an ellipsis (…)
예2) If the first character of the file name is > → If the first character of the file name is a greater than symbol (>)
예3) any of the following characters: # & . ^

4

국문 어법과 PL(Product Liability) 문구

• 띄어쓰기, 사이시옷 등 국문법 → 강의자료(국문 어법) 참고

• PL 문구(매뉴얼 안전 정보) → 강의자료(2Safety) 참고

5

매뉴얼 아키텍처

DITA(Darwin Information Typing Architecture)가 제시한 구조

• 개념 정보

• 절차 정보

• 참고 정보

IBM 진술 방법론

1. 절차 제목: 태스크 타이틀

2. 준비 정보: 절차의 목적/정의/숙지사항/효과/주의 문구; 만약 해당 태스크를 진행하기 위해 사전에 준비해야 할 사항이 있다면 반드시 진술해야 함

3. 절차 진술: 태스크 진행 절차 기술

4. 절차 상세 진술: 각 절차 단계별로 하위 절차나 참고/주의 사항 기술

5. 조건별 진술: 순서와 상관 없이 조건이나 옵션에 따라 작업을 진행하는 경우, 이를 기술

6. 시각 정보 요소: 단계별로 해당 이미지 삽입

7. 절차 완료 진술: 전체 태스크 진술이 완료된 후 어떤 일이 일어나는지와 추가적으로 어떤 작업을 진행해야 하는지를 기술

✔ 절차까지만 쓰고 마지막 7번 단계는 생략하는 경우가 많은데, 필요 시 넣도록 한다.

목차 구성 체크리스트

Image Added

태스크 토픽 작성 체크리스트

Image Added

나쁜 토픽

• 기능 중심이고 사용자의 행위 중심이 아님

• 개발자 관점의 표현과 용어 사용

• 태스크의 목적이나 사전 정보가 없음

• 예제가 되는 시각 정보가 적음

• 행위와 관련 없는 내용이 단계에 포함됨

• 절차가 너무 단순하고 세분화되어 있지 않음

• 수행 작업 후 이어지는 결과에 대한 내용이 없음

6

7

8