So, what’s a technical writer?

Technical Writer란? Translator다!

단순히 언어를 잘하는 Translator를 의미하는 게 아님

복잡한 기술적인 개념들을 분명하고, 이해하기 쉽게 설명할 수 있는 사람이다.

someone who can explain complicated concepts in clear, easy-to-understand prose

 

Mission of a technical writer

to explain to a nonexpert how to use that technology

전문가가 아닌 사람도 해당 기술을 이해하고 잘 사용할 수 있도록 설명하는 것

 

Requirements

Technical Writer가 갖춰야 할 4가지 basic skill sets

1. Knowledge of technology

Technical writing에서 말하는 technical이란 반드시 프로그래머 정도의 수준을 갖춰야 한다는 게 아님.

(마스터해야 한다는 의미도 아님)

하지만, 적어도 문서화할 기술에 대한 어느정도의 기본적인 지식이 있어야 함

& 새로운 기술을 배울 의지가 있어야 함

 

Ignorance is bliss

오히려 제품 지식이 부족한게 도움이 될 수 있다

why? 새로운 하드웨어나 소프트웨어 사용법을 배우면서, 실제 유저들이 마주하게 될 같은 이슈들을 만나게 될거임.

이 경험을 반영해서 문서에 더 상세히 설명하는 기회로 활용할 수 있음

2. Writing ability

• 복잡한 정보를 문서의 독자에 맞는 콘텐츠로 세분화 (break down)할 수 있는 능력 매우 중요 ⭐️
• 테크니컬 라이터의 미션은? 독자에게 제대로된 정보를 전달할 수 있는 콘텐츠를 만들어내는 것

 

What makes good writing?

• Clear
• Easy to understand
• Not subject to misinterpretation
• Concise
• Easy to follow

 

3. Organizational skills

• 수집한 정보를 구조화 (organize) 해야 함
• readers (독자, 사용자)가 제품을 이용할 때 어떤 부분 어려움을 겪는지 파악하고 이를 문서에 이해하기 쉽게 녹여낼 수 있어야 함
  • 그래서 FAQ나 고객들이 어떤 질문을 많이 하는지 파악하기도 함
• Technical writer에겐 새로운 정보를 습득하고, 이해하고, 구조화하고, 우선순위를 정리하고 전달하는 게 업

 

4. Detective (and people) skills

• 정보를 얻어내는 소스
  • technical specifications
  • prototypes
  • product developers or subject matter expert
    • technical experts는 항상 바쁜데 어떻게 커뮤니케이션하고 원하는 정보를 얻어낼 것인가?도 중요한 스킬
• filtering information ⭐️

때로는 어떤 정보가 관련있는지를 찾는 게 문제임

 

출처: Technical Writing 101