[한빛미디어] 도서서평 - Docs for Developers 기술 문서 작성 완벽 가이드

이번 달 서평 책은 Docs for Developers 기술 문서 작성 완벽 가이드

 

2023년 5월 24일 기준 한빛 출판 네트워크 BEST4에 올라와있는 책이다!

 

 

책정보

저자: 자레드 바티, 재커리 사라 콜라이센, 젠 램본, 데이비드 누네즈, 하이디 워터하우스, 하성창

출간: 2023년 04월 10일

페이지: 332쪽

 

책소개

소프트웨어 개발자를 안내하는 테크니컬 라이팅을 위한 실무 노트
우아한형제들, 카카오, AWS, LINE Plus, 쿠팡, NHN, 데브시스터즈, 넷마블 등
국내 테크니컬 라이터 11인 인터뷰 특별 수록!

이 책은 ‘강아지 음성 번역 서비스’를 만드는 개발 팀의 스토리를 따라가며, 개발 문서를 만드는 과정을 단계별로 배우도록 구성되었습니다. 단계별 예제, 템플릿, 가이드를 통해 이론적인 내용뿐만 아니라 문서를 효과적으로 작성하고 관리하는 방법도 배우게 됩니다. 단계에 맞는 문서화 기술을 배우고, 사용자 니즈 이해부터 문서 작성, 유용한 개발자 문서 배포 및 유지까지 프로젝트 관리와 소프트웨어 개발 라이프사이클 전체를 한 권에 담아 설명합니다.

또한 부록에는 우아한형제들, LINE Plus, 카카오엔터프라이즈, NHN 클라우드, 넷마블, 데브시스터즈, AWS, 쿠팡에서 활동하는 국내 유명 테크니컬 라이터 11인의 인터뷰가 수록되었습니다. 테크니컬 라이팅이 무엇인지, 업계에서 테크니컬 라이터의 역할에 대해 설명합니다. 이미 테크니컬 라이팅의 세계를 경험한 선배들의 다양한 경험과 이야기를 들을 수 있습니다.

Docs for Developers 기술 문서 작성 완벽 가이드 - YES24

---

나의 서평

 

개발 감자 신입이지만 생각보다 개발자도 문서를 작성해야할 일이 많다. 사용자 가이드, API 명세서, URL 리스트 등등..

개발자 - 개발자의 문서 뿐 아니라 개발자 - 사용자 간의 문서또한 작업할 일이 생기는데, 그 시점에 이 책을 서평할 기회를 갖게되었다.

 

갑자기 문서를 만들어야한다는 업무가 주어졌는데 레퍼런스가 없는 상황에서 막막하기만 했다. 하지만 기술 문서 작성 완벽 가이드 책 덕분에 어디서 부터 시작해야할 지 진입점을 찾을 수 있었다. 뭔가 만들어야 한다 라는 생각에 빠져있던 나의 초점을 문서를 건넬 대상 이해부터 시작해야한다고 시선을 돌려준 덕분에 첫 단추를 잘 꿸 수 있었다.

 

사용자에게 제시할 수 있는 목표를 정하고, 사용자를 이해하고, 사용자의 니즈를 파악한 후 작업을 시작하니 문서의 윤곽을 잡아가는데 훨씬 수월해졌다. 무작정 뭔가 만들어야 한다는 막막함에서 벗어날 수 있었다. 이후 책의 목차를 따라 초안을 만들고 편집하고 검수받고 수정하고 통합하는 과정을 거쳐가면서 팀장님이 원하던 문서규격을 만들었다. 그리고 그 만든 문서규격를 따라 다른 프로젝트들에도 사용하기로 했다. 

 

처음 맡는 업무에 막막했지만 기막힌 타이밍에 만난 이 책 덕분에 기간내에 좋은 결과를 받게 되었다. :) 햅삐 

 

마지막부분에 테크니컬 라이터분들의 실제 업무 경험 인터뷰까지 들어있어서 도움이 많이됐다.

 

 

"한빛미디어 <나는 리뷰어다> 활동을 위해서 책을 제공받아 작성된 서평입니다."