테크니컬 라이팅 - 개발자를 위한 글쓰기(1)

 

테크니컬 라이팅과 기술문서

테크니컬 라이팅 : 과학 분야에서 정보를 정확하게 전달하기 위한 글쓰기

→ 기술적 글쓰기, 기술 글쓰기

→ 넓게 보면 보도자료, 메모, 보고서, 이력서 등도 포함

 

기술문서 : 항상 특정 독자를 대상으로 작성

• 특정 독자를 대상으로 특정 목적을 갖고 특정 정보를 전달
• 쉽게 이해할 수 있도록 정확한 정보만을 전달
• 어떻게 써야 명확하게 잘 전달할 수 있을까
• 객관적 사실, 정확한 정보만을 다뤄야 한다

 

테크니컬 라이팅 5단계

1. 계획 세우기
   1. 목적과 문서를 읽는 독자를 구체적으로 정함
   2. 필요한 정보를 수집
2. 구조 잡기
   1. 수집한 정보를 작업 순서에 따라 차례대로 배열하는 단계
   2. 정보를 묶어서 구조화
3. 초안 작성
   1. 전달할 정보를 모두 넣는 것에 초점
   2. 가장 자신있는 부분부터 채워 나가기
4. 검토와 재작성
   1. 내용, 문서 구조, 문장 연결, 문법, 맞춤법
   2. 많은 시간 할애
5. 배포

개발자와 테크니컬 라이팅

협업에서 중요한 요소는 ‘의사소통’

소통의 결과를 가잘 오래, 정확하게 기억할 수 있는 방법 → ‘글’

 

그냥 쓰는 것이 아니라 제대로 쓰기

중요한 것은 독자가 ‘이해하기 쉽게’ 글을 쓰는 것

---

문서 작성 계획 세우기

대상 독자를 정한다

• 기술 문서를 쓸 때 중요한 것은 독자 정하기
  • 내용의 깊이 조절, 전문 용어 사용 범위와 어조를 정할 수 있다

독자 분석 체크리스트

• 비개발자
  • 개념, 기본정보, 용어를 설명
• 개발자
  • 일반적인 용어 설명은 하지 않아도 된다.
  • 기초적인 내용을 길게하면 오히려 지루해질 수 있다.
• 독자가 섞여 있을 때
  • 각 독자 수준에 맞춰 일단 내용을 모두 작성
  • 원하는 정보만 선택해 볼 수 있게 목차를 잘 만들어야 한다.