기술블로그 글쓰기 교육 후기

발표자 : NHN 유영경 수석

​

기술 블로그 원칙

​

1. 대상 독자를 정해서 작성해야 한다.

(전문가, 기술자, 임원, 비전문가)

​

1. 독자에 맞춰 내용을 다르게 작성한다.

​

1. 사실만 작성해야 한다.

​

사실을 전달하고 특정 독자에 맞춰 작성한다.

​

기술 블로그 작성 방법 7가지

1. 계획을 세운다.

2. 대상 독자를 정한다.

3. 핵심부터 쓴다.

4. 근거와 사례를 든다.

5. 일관되게 쓴다.

6. 시각 자료를 활용한다.

7. 검토하고 고친다.

​

주체를 구체적으로 잡는다.

-> 쓸거리는 충분한가?

자료조사, 메모 등.

-> 문서 구조 잡기

-> 일정 잡기

테스트 일정. 검토와 고치는 시간을 전체 일정에서 40% 정도 사용한다.

​

대상 독자를 선택하면 어조를 선택해야 한다.

• 어조를 선택했다면 일관되게 작성해야 한다.

• 풀이와 약어를 사용하면 좋다.

​

핵심을 작성한다.

• 결론과 이유, 배경 등 순으로 작성한다.

  위와 같은 형태는 역피라미드 구조 작성 방법이다.

주관적인 것을 제외한다.

​

일관되게 작성한다.

• 용어부터 일관되게 맞춘다.

• 우리나라 문서는 한글 기준으로 작성한다.

• 표현.

• 국내 해외 도서들을 통하여, 작성 스타일 가이드를 알아볼 수 있다.

​

검토를 계속하면 가독성을 높일 수 있다.

** **- 하루 정도 시간을 두고 문서를 다시 검토한다.

• 소리 내서 읽어 본다.

• 동료나 지인한테 검토를 요청한다.

• 분명한 글 꼬리를 사용한다.

• 대명사를 제거하고 명확하게 가리킨다.

• ~대한, ~통한을 제거하고 문장을 교정한다.

• 은어를 제거한다.

• 형식적인 표현을 사용한다.

• 한자어 외국어 순화한다.

• 줄임말을 제거한다.

• 고유명사를 사용하지 않는다.

• 필요 없는 말을 덧붙이지 않는다.

• 수동태보다 능동태로 작성한다.

• 중복 표현을 제거한다.

• 맞춤법을 검사한다.

​

UI 에서 오류 메시지를 나타낼 때, 상태, 원인, 해결책 (구체적인 설명)으로 표현한다.

​

​