Technical Writing 란

기술 정보를 정확하게 전달하기 위한 글쓰기 기법

B) Technical Writing 의 필요성

글쓰기를 잘 하면 논리적이고 체계적으로 정보를 정리할 수 있음

  1. 시간 절약: 커뮤니케이션의 효율성 증대
  2. 제품 가치 증대: 전파력 및 응용력 향상
  3. 개인 및 조직 역량 강화

C) 글쓰기 절차

C.1) 계획

  • 작성 목적을 정하기
  • 내용을 구성하고 정보를 수집
  • 작업 일정 짜기

C.2) 초안 (Drafting)

구성에 맞춰 내용을 작성하고 용어를 정리

C.2.1) Drafting Tip

서식, 문법 생각 없이 생각에만 집중하여 아웃라인 안에 내용을 채워보자!

C.3) 수정

  • 퇴고 및 검토
  • 사용성 확인
  • 피드백 반영
  • 동작 확인 등 QA

C.3.1) 수정 사항

  • 처음 분석한 독자가 바뀌지 않았는가?
  • 독자가 필요한 내용을 쉽게 찾을 수 있도록 목차 구성이 효과적으로 구성 되었는가?
  • 독자가 필요로 하는 중요한 정보가 누락되지 않았는가?
  • 적절한 예제나 내용이 작성 되었는가?

C.3.2) 검토가 필요한 특성들

  • 정확성: 기술적 오류 없이 정확한 정보를 전달하는가?
  • 명확성: 내용의 모호함 없이 한 번에 이해 되는가?
  • 간결성: 빠르고 정확하게 정보가 이해 되는가?
  • 일관성: 한 사람이 쓴 느낌을 주는가?

D) 각종 글쓰기 팁

  1. 예제와 사용 예시는 꼭 넣기
    1. 읽는 시간을 절약해주며, 주로 복사 + 붙여넣기로 쓰는 경우가 많음
  2. 전문 용어와 사내 용어
    1. 남발 시 독자의 이해를 저하할 수 있음
    2. 독자 수준에 따라 허용 범위가 다르다

E) Related

F) References

MECE: https://igotanoffer.com/blogs/mckinsey-case-interview-blog/mece