[서평/23-13] 개발자를 위한 글쓰기 가이드: 예제로 배우는 테크니컬 라이팅 핵심 비법

독서기간_2023년 1월 27일
저자_유영경
출간일_2021년 2월 26일

 

---

그냥 재밌어 보이길래 빌렸다. 내용도 단순해 보이고 간결하게 딱딱 쓰여있는 게 개발자 안성맞춤이라 생각됐다.(???) 읽어본 후기로 가볍게 읽고 짚고 넘어가기 좋다. 읽으면서 지금까지 썼던 글들은 이 항목들에 맞게 썼었나 되돌아보는 기회도 가질 수 있다. 테크니컬 문서뿐만 아니라 일상에서 소통할 때, UI 개발할 때 도움이 될 것 같다. 그야말로 독자(청자)가 누구인지에 따라 글을 쓰는(말을 하는) 계획이 달라지기에.

'검토' 챕터는 특히 도움이 된다. 번역투, 은어, 이중부정 등 아름다운 한국어 사용을 위해서 인지하고 있으면 좋다!

 

이과생치고 맞춤법에 조예가 깊고 글을 좀 쓴다라는 자부심이 있다. 뭐 내가 얼마나 글을 써봤나 싶지만 ㅋㅋ.. 글을 더 잘 쓰고 싶고 기왕이면 말도 더 잘 하고... 자소서 쓸 때 도움이 되지 않을까 싶다. 

 

---

글쓰기 계획 세우기

• 독자가 누구인지 파악하라.
• 중요 용어와 약어는 풀이하자.
• 어투 전반적인 영향을 준다.

 

초안 쓰기 & 시각화 요소로 가독성 높이기

• 두괄식으로 작성하라.
• 객관적인 근거를 대라.
• 쉽게 쓴다. 기술 문서라 할지라도 잘 쓰지 않는 한자어 등 형식적으로 쓸 필요 없다. 개념도 복잡한 데다가 어려운 용어가 자주 등장하는 문서인데 설명까지 장황하면 내용을 파악하기 더 어려워진다.
• 점 목록은 각 항목이 대등하고, 일관성 있게 작성한다. (‘다음은  ~ 입니다.’, ‘ ~ 주요 기능은 다음과 같습니다.’ 설명 문구 추가한다.)
  
  

 

검토와 재작성

• 소리내어 읽기, 시간을 두고 다시 읽기, 인쇄해서 읽기
• 은어는 형식적인 표현으로 바꾼다. 
• 단정적인 어조로 확신 있게 쓴다.
• ‘진행’, ‘처리’, ’필요‘, ’발생‘ 등 덧붙이는 말을 삭제한다.
• 의미가 같은 표현은 한 번만 쓴다. (’하게 되면‘, ’기존에 이미‘, 한자어와 한자 풀이를 함께 쓴 예)
• 피동태(번역체), 이중피동 주의(보여진다)
• 번역체: ~에 대해, ~에 의해, ~를 통해, 가능/불가능하다, 자유도가 높다, ~를 가지고 있다(사람 주체가 아닌 사물이 ’가지다‘는 자연스럽지 않다), ~ 경우 ’통해‘는 명확한 표현으로 바꾼다.
• 조사를 덜어낸다. (을/를을 줄여보자, 의를 빼보자 다른 형용사나 동사로 바꾼다)
• 맞춤법!!!!! 
• 외래어 표기

 

오류 메시지 3요소: 상태, 원인, 해결 방법

(사과문에 꼭 필수적인 3요소)