개발자를 위한 글쓰기 가이드 시작!!

1. 테크니컬 라이팅이란?

기술이나 과학 분야에서 정로를 정확하게 전달하기 위한 글쓰기를 의미한다.

 

2. 기술 문서의 특징이란?

- 특정 독자( 개발자, 고객 )를 대상을 특정 목적을 갖고 특정 정보를 전달.
- 어떤 작업을 수행하거나 어떤 주제를 쉽게 이해할 수 있도록 "정확한" 정보만을 전달한다.
- "어떻게 써야 명확하게 잘 전달할 수 있을까?"에 초점을 맞춰서 전달한다.

3. 일반 글쓰기와의 차이?

일반 글쓰기에서는 주관적인 생각, 공상, 관념 들을 포함할 수 있지만, 기술 문서에서는 객관적인 사실, 정확한 정보만을 다뤄야한다.

4. 테크니컬 라이팅의 5단계

• 계획 세우기
  - 문서의 목적과 문서를 읽을 독자 선정
  - 문서 작성에 필요한 정보를 수집
• 구조 잡기
  - 수집한 정보를 작업 순서에 따라 차례대로 배열하는 단계
• 초안 작성
  - 전달할 정보를 모두 넣는 것에 초점을 맞춤
• 검토와 재작성
  - 초안을 읽어 보며 잘못된 내용과 문장을 확인해 고치는 단계
• 배포
  - 완성된 문서를 독자에게 배포하는 단계