<개발자를 위한 글쓰기 가이드> - 유영경

 

📖 책 소개

 

‘글 잘 쓰는 개발자’가 되고 싶어 여러 글쓰기 책을 읽어보던 중 발견한 책이다. Microsoft, NAVER, NHN에서 테크니컬 라이터로 일하는 유영경 저자가 작성한 이 책은 개발자를 위한 글쓰기 노하우를 담은 책이다.

 

책의 순서를 살펴보면, 가장 먼저 1부에서 ‘테크니컬 라이팅(기술 글쓰기)’가 무엇인지 소개한다. 책의 핵심인 2부에서는 테크니컬 라이팅의 45가지 원칙을 설명한다. 45가지 원칙에는 문서 작성 계획부터 초안 작성법, 시각화 요소 활용과 퇴고 방법까지 모두 다룬다. 마지막 3부에서는 메일, 회의록, 오류 메시지와 사용자 가이드 등 유형별 테크니컬 라이팅을 살펴보며 작성 노하우를 알려준다.

 

개발자가 현업에서 자주 사용하는 문장으로 설명하는 것이 이 책의 최고 장점이다. 책의 등장하는 예문들은 개발자라면 익숙한 문장들이고, 실제로 개발자들이 자주 작성하는 잘못된 문장들을 잘 짚어준다. 책의 소개된 내용을 내 블로그에도 검색해 봤는데, 잘못된 문장을 많이 찾아낼 수 있었다.

 

이런 이유로 글을 잘 쓰고 싶은 개발자가 있다면 가장 먼저 추천하고 싶은 책이다. 개발자가 글을 쓰는 상황에 맞춰 가이드를 해줄 뿐 아니라, 일반적인 글쓰기에도 도움이 되는 팁도 많다. 앞으로 기술 글쓰기를 할 때마다 이 책을 참고해가면서 더 좋은 글을 써보려고 노력해야겠다.

 

 

✍️ 인상적인 내용 정리

 

(테크니컬 라이팅 45가지 원칙 요약)

 

• 문서 작성 계획 세우기
  • 01 - 가장 먼저 대상 독자를 정한다.
  • 02 - 독자에 맞춰 깊이를 조절한다. (비개발자 → 개념과 기본 용어 설명, 개발자 → 용어 설명 생략하고 기초적인 내용은 간단히)
  • 03 - 독자와 목적에 맞춰 어조를 정한다. (어조는 일관되게 사용한다.)
  • 04 - 주제를 구체적으로 정한다. (작성자가 다룰 수 있는 범위로 / 예 : JavaScript 사용법 → JavaScript에서 타임존 다루기)
  • 05 - 문서 종류를 정한다. (메일, 회의록, 보고서, 가이드, 튜토리얼)

 

• 초안 작성
  • 06 - 처음부터 완벽한 글을 쓰겠다는 생각은 내려놓고 일단 쓴다.
  • 07 - 명확성, 간결성, 일관성을 지킨다. (단호하고 명확한 표현을 사용하고, 짧고 쉽게, 일관된 내용을 쓴다.)
  • 08 - 핵심부터 쓴다. ★ (주제 → 중요한 사실 → 예시 → 정의 순서)
  • 09 - 제목에 요점을 담는다.
  • 10 - 문장 하나에 주제 하나만 쓴다. ★ → 문장을 짧게 쓰는 연습을 하자.
  • 11 - 객관적 근거를 든다. (수치 데이터 등)
  • 12 - 독자가 이해하기 어려운 전문 용어는 피하고, 특정 집단만 이해할 수 있는 은어나 줄임말을 지양한다.
  • 13 - 전문 용어나 약어를 쓸 때는 (독자에 맞춰) 풀이를 쓴다.
  • 14 - 용어는 일관되게 사용한다. (예 : 스토리지, 저장소 → ‘저장소’로 통일)
  • 15 - 쉽게 쓴다. (비슷한 내용을 줄이고 꼭 필요한 내용만 남겨 짧게 쓴다.)

 

• 시각화 요소로 가독성 높이기
  • 16 - 적합한 시각 자료를 사용한다. (표, 그림, 목록 등)
  • 17 - 점 목록과 순서 목록을 활용한다. (남발하진 않도록 유의)
  • 18 - 스크린숏을 활용한다 (꼭 필요할 때만, 텍스트는 그림 바깥으로)
  • 19 - 정보 비교를 위해 표를 사용한다. (무리해서 사용X, 간단한 것은 목록으로)
  • 20 - 데이터 성격에 맞는 차트를 사용한다. (선, 막대, 파이 차트 등)
  • 21 - 시각 자료를 쓰기 전에 소개부터 한다. ★ (이미지, 목록이 어떤 내용인지)
  • 22 - 시작 자료를 설명하는 캡션을 활용한다. (보통5개 넘어가면)

 

• 검토와 재작성
  • 23 - 객관적으로 문서를 검토한다.
  • 24 - 맥락에 맞는 적확한 단어를 선택한다.
  • 25 - 은어를 사용하지 않는다. ('무거운', '뜨면', '깨지다' 등)
  • 26 - 대명사는 일반 명사로 바꾼다. (’여기’, ‘이를 통해’)
  • 27 - 고유한 이름은 정확히 쓴다. (MS → Microsoft)
  • 28 - 숫자와 단위를 정확하게 쓴다. (4G → 4GB)
  • 29 - 단정적인 어조로 확신 있게 쓴다. (‘~할 것이다’, ‘~하게 됩니다’ → ‘~합니다’)
  • 30 - 글꼬리를 뚜렷하게 쓴다.
  • 31 - 주어와 서술어를 일치시킨다.
  • 32 - 문장은 짧게 줄인다.
  • 33 - 군더더기 표현을 없앤다. ★ (‘진행’, ‘처리’, ‘필요’, 발생’)
  • 34 - 의미가 같은 표현은 한 번만 쓴다. (‘과반수 이상’ , ‘기존에 이미, ‘하게 되면’ )
  • 35 - 피동태 대신 능동태로 쓴다. ('보여지다' 같은 이중 피동도 지양)
  • 36 - 복잡한 번역체를 다듬는다 ★★ (’~에 대해’, ‘~에 의해’, ‘~을 통해’, ‘가능하다’, ‘가지고 있다’, ‘~의 경우’
  • 37 - ‘통해’는 명확한 표현으로 바꾼다. ★
  • 38 - ‘무엇은 ~ 무엇이다’ 형식으로 쓰지 않는다.
  • 39 - ‘~해 주다’ 대신 ‘~하다’를 쓴다.
  • 40 - 조사를 덜어낸다. ('을/를', ‘~의’)
  • 41 - 재작성한 문서를 동료와 검토한다.
  • 42~45 - 맞춤법, 외래어 표기법, 띄어쓰기, 문장 부호를 검토한다.

 

https://product.kyobobook.co.kr/detail/S000001624711

개발자를 위한 글쓰기 가이드 | 유영경 - 교보문고