NHN 개발자 기술 글쓰기 세미나 - 2020.1.15

회사에서 사내기술불로그 오픈 기념으로 강의가 열렸는대, 잽싸게 신청을 했다ㅎㅎ
신청한 이유는 블로그 또는 사내에서 작성한 나의 문서가 다른 사람들이 이해하기 쉬울까? 라는 생각에서 신청하게되었다.

세미나 주제

 - 기술 글쓰기

강사님

 - NHN 테크니컬 라이터 유연경 강사님

세미나 내용

 - 기술 글쓰기의 기본 7원칙

 - 오류 메세지 쓰기

 - 글로벌문서 작성시 유의 할점

핵심

- 특정 사실을 특정 독자에게 명확하고 간결히게 전달하는 것이 핵심 

★기본 7원칙

1. 계획을세운다

2. 대상독자를 정한다

3. 핵심부터쓴다

4. 근거와사례를 든다

5. 일관되게 작성한다 

6. 시각자료를 활용한다

7. 검토하고 고친다

1.계획

- 주제를 선정하고 주제를 다룰 내용을 구체화 한다

- 주제하나에 집중한다.

- 작성 할 내용은 충분히 준비되어 있는가?

- 경험과 내용을 녹여서 만들어야함

- 개념만 그대로 작성하면 문서로의 가치가없음

- 문서구조잡기 

  1)마인드맵이 효과적이다

- 일정 

  1) 테스트 일정까지 고려하여 계획한다

  2) 고치기단계에서 40%배정하는게 좋다(그만큼 고치기단계가 중요하다는 것)

2. 대상독자를 정한다

- 어조

  1) 원칙은없음

  2) 일관적이게 사용할것

- 독자의 기술적 깊이 (전문용어)

  1) 기술적배경,환경이 작용함

  2) 용어와 약자 (용어풀이는 적어 줄 것)

- 문서에 독자를 지정해버리는 것도 좋은 방법

3. 핵심부터쓴다

- 결론, 이유 먼저 작성

- 근거, 배경 작성

- 참고사이트

- 중요도에 따라 역피라미드구조로 작성

- 제목에 핵심을 요약할 것

4. 근거제시

- 이유가 있다는 것이중요 (설득의 심리학)

- 질문이안나올까 ?의 관점에서보면됨

- 수치가 가장좋은 객관적 데이터이다 

5. 일관되게 작성한다

- 일관된 용어를 사용한다 ex) 서비스를 운영합니다, service를 운영합니다

- 일관된 표현을 사용한다

- 일관된 스타일을 사용한다(외국의 경우 시카고 매뉴얼 가이드라는 것이 있음)

6. 가독성을 높이는 방법

- 목록, 표, 차트, 그림

- 차트를 보여줄땐 간단한 설명을 하고, 차트를 보여주는 것이 좋음

7. 검토

- 마지막에 검토하는게 좋다

- 나를 객관화 할수 있는 방법

  1) 24시간 후에 봐라

  2) 소리내서 읽어보자

  3) 동료검토가 베스트 하지만 사실상 어려움

- 주술호응

 1) 분명한 글꼬리

- 명확하게 지칭(대명사를 사용하지 않는다)

- 대한 통한을 빼 보자 (~대한, ~통한)

- 은어 구어체 사용 x

- 형식적인 표현사용(서버에서 튕긴다X, 프로그램이 무겁다 X, 로그를 까보면 X..)

- 한자와 외국어 순화 ex) 솔루션(x) 설루션(o) , 캐쉬(X) 캐시(O) , 라이센스(X) 라이선스(O) NAVER 맞춤법 사용기 권장

- 줄임말x (고포류 ,고스톱,포커류의 게임)

- 외국기업은 서비스에서 오히려 한국말을 더 많이씀 ex)  apple 사이트에 '톺아보기'라는 단어를씀 (상세히 보기와 같은 의미)

- 간결

  1) 필요없는말을 덧 붙이지 않는다

  2) 수동태보다 능동태로

  3)  중복표현 제거(보안위협을 사전에 미리'방지'하고 '예방'할 수있습니다)

- 맞춤법 (신뢰도 문제)

오류메세지 쓰기

- 독자가 꼭 읽어야하는 문장

- 오류메세지에는 상태, 원인, 해결책이 들어가야 좋음

- 버튼 텍스트를 명확하게(결제를 취소하겠습니까?, [취소][확인] ) 부정문은 번역했을때 문제가된다

글로벌서비스에서 유의할점

현지화

- 서비스를 특정 지역의 언어와 문화에 맞춰 바꾸는 일

- 문화 인종 종교등을 고려

- 제스처도 주의

- 성역할 고정관념

- 번역하기 쉬운 문장(담당자, 체크 권장X)