기술문서 작성의 A-Z [개발자를 위한 글쓰기 가이드]

저자	유경영
출판사 & 발행년도	로드북 & 2021
키워드	개발문서
분야	소프트웨어 개발
만족도	★★☆☆☆
페이지	288pg

 

1. 왜 읽었는지? 

우연히 회사 도서관에 갔는데, 개발자와 글쓰기에 관한 두개의 키워드가 가장 눈에 띄었다.

그래서 궁금증에 일단 바로 빌려서 읽었다.

 

2. 가장 인사이트를 준 문장

기술 문서 작성의 단계
계획 세우기 - 구조 잡기 - 초안 작성 - 검토와 재작성 - 배포

 

사실 이 문장만 완벽하게 이해해도 이 책의 대부분을 이해한 것이다. 이 플로우를 꼭 잊지 말자.

 

3. 책을 읽고 생각하고 느낀점

책은 얇고, 읽기 너무 쉬웠다. 그렇다고 내용이 부실한 것은 아니었다. 사례나, 플로우, 노하우 등을 잘 알려줘서 꽤나 좋은 책이었다.

그런데 대부분은 내가 이미 알던 내용이라서 아쉬웠다. 100% 흡수한 것같다.

글쓰기에 관심있는 나라서 이해가 빨랐을 수도 있다. 개발자들은 사지 않고 빌려볼 수 있으면 빌려보는 것을 추천한다.

 

4. 책을 한줄로 정리하자면? & 어떤 사람에게 추천?

기술문서를 작성의 모든 가이드 & 기술 문서를 작성하는 개발자, 테크니컬 라이터

 

5. 책을 읽고 성장한 점

1. 기술 문서를 작성하는 플로우를 알게됐다.
2. 어떤 방식으로, 어떤 마인드, 어떤 내용이 기술문서에 필요한지 알게 됐다.

 

6. 스토리 텔링 [줄거리 요약]

기술 문서를 쓰는 목적이 정확한 정보를 전달하려는 것이므로 ‘어떻게 써야 명확하게 잘 전달할 수 있을까'에 초점을 맞춰야 한다.

 

기술 문서 작성의 단계

1. 계획 세우기
   1. 문서를 읽을 독자를 구체적으로 서술
   2. 주제를 정하고, 필요한 정보 수집
2. 구조 잡기
   1. 수집한 정보를 차례대로 배열
3. 초안 작성
   1. 전달할 정보를 모두 넣는 것에 초점
4. 검토와 재작성
   1. 퇴고
5. 배포

 

제품이나 서비스 가이드와 같이 정보를 전달해야 하는 문서에는 두괄식으로 써야 한다.