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

 

분위기를 좌우할 어조를 정한다

 

어조

• 말의 가락을 가리키는 말로, 더욱 더 자연스럽고 효과적으로 표현할 수 있게 도와주며 말하는 이의 감정과 기분을 전달할 수 있게 한다.
• 제품, 서비스의 성격, 주요 사용자층, 전달하고 싶은 이미지 등을 고려.
• 단독으로 정하는 것이 아니라 협의를 통해 정한다.
• 어조를 정하면 일관성있게 작성한다.

 

주제를 구체적으로 정한다

• 광범위한 주제를 구체적으로 정한다.
• 작성자가 다룰 수 있는 범위로 주제를 정한다.

ex)

 

작성할 문서의 종류를 정한다.

• 메일
  • 독자 : 받는사람
  • 정보를 간단하게 공유하고 업무를 요청할 목적
  • 의사결정을 받기 위해 작성

 

• 회의록
  • 협의한 내용을 공유하고 오래 기억할 수 있게 작성하는 문서 형식
  • 참석하지 않은 사람이 나중에 읽어도 이해할 수 있게 명확히 작성

 

• 보고서
  • 어떤 대상을 조사, 현상을 오래 관찰한 결과를 정리해 일정한 양식을 갖춰 작성
  • 발표용은 PPT파일

 

• 가이드
  • 제품이나 서비스의 사용방법, 특정 작업을 수행하는 방법
  • 퀵 스타트 가이드는 비디오 형식으로도 많이 생성

 

• 튜토리얼
  • 독자를 어렵지 않게 시작할 수 있도록 단계별로 이끌어주는 문서
  • 복잡하고 자세한 배경 정보는 생략하고 빠르게 제품과 친숙해지게 하는 것이 목표

 

---

초안작성

일단 쓴다

• 처음부터 완벽한 글을 쓰겠다는 생각은 X
• 정한 독자를 떠올리며 궁금해할 내용, 전달해야 할 내용을 빠짐없이 추가하는데 집중
• 흐름 이상, 내용 정확하지 않음, 문법, 맞춤법 신경쓰지 않고 일단 넣고 싶은 내용 다 서술

 

 

명확성, 간결성, 일관성의 3원칙

 

명확성

• 모호함이 없고 확실
• 단호하고 명확한 설명과 표현
• 단정적이지 않은 표현, 추측성 표현 → 신뢰도 하락

 

 

간결성

• 문장을 간결하게 쓴다
• 짧게 유지, 5단락 안팎의 문장으로 구성

 

 

일관성

• 전체에서 설명하는 내용이 일관돼야 한다
• 같은 의미의 용어나 설명 방법도 일관되게 유지

 

 

핵심부터 쓴다

• 정보를 전달해야하는 문서에서는 핵심 내용을 제일 앞에 쓴다
• 답을 먼저 제시 → 배경과 근거 설명 [역피라미드 방식]

 

 

역피라미드 방식

• 결론, 핵심, 주제부터 제시 → 이후 근거나 데이터를 설명하는 방식
• 마지막에는 참고자료나 정보를 추가

• 역피라미드 구조의 장점
  • 독자들이 요점을 파악하는데 많은 시간을 소비X
  • 문서 주제를 빠르게 파악해 세부 내용을 이해하기 쉽다
  • 문서를 끝까지 읽지 않더라도 핵심은 파악할 수 있다
  • 필요한 부분만 골라 읽기 쉽다

 

제목에 요점을 담는다

• 제목만 봐도 다루려는 내용이 무엇인지 파악할 수 있게 만들어야 한다
• 제목 아래 단락의 요점을 압축해 제목으로 쓴다

 

 

문장 하나에는 주제를 하나만 쓴다

• 문장을 길게 쓰다보면 주어에 맞는 술어를 쓰지 않아 비문을 만들 확률이 높아진다
• 같은 내용을 쓰더라도 짧게 쓰는 연습 필요

 

 

객관적인 근거를 댄다

• 기술 문서에서는 감정에 호소, 주관적 X → 객관적으로 입증된 근거, 수치 데이터
• 기술 문서에서는 추측성 주정, 입증되지 않은 사실은 적지 않아야 한다