메뉴 바로가기 검색 및 카테고리 바로가기

한빛미디어

독자리뷰

[리뷰] Docs for Developers 기술 문서 작성 완벽 가이드

jangej1***

|

2023-05-30

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

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

  • 저자 : 자레드 바티 , 재커리 사라 콜라이센 , 젠 램본 , 데이비드 누네즈 , 하이디 워터하우스
  • 번역 : 하성창
  • 출간 : 2023-04-10

IMG_2536.jpg

 

 

이번에 읽은 책은 기술문서 작성 완벽가이드 라는 책이다. 요즘 회사에서 여러가지 작업한 것들, 진행했던 것들을 새로 정리하고 가다듬는 필요가 있을 것 같아서 어디 좋은 책 없나 찾았다. 때마침 좋은 책이 나와서 신청해서 읽어봤다.

 

 

진짜 평소에 이렇게 쓰면 좋지 않을까 하면서 생각하던 내용들이 훨씬 더 잘 명료하게 정리되어 있었다. 다양한 형식에서 이렇게 쓰면 좋다 하는 내용들을 압축해서 담아놨다. 이거 읽고 나서 확실히 도움이 많이 되는 것 같다.

 

적절한 예시와 요점들을 눈에 띄게 편집해둬서 참 보기 편했던 것 같다.

 

깃허브 같은데에서 많이 보던 Readme 나 release note 같은 것들도 작성할때 사실 크게 신경쓰지 않고 작성했었고, 사내 기술 문서를 작성할때도 나름 많이 고치고 읽는 사람들을 고려해서 쓴다고 했지만, 이 책에서 말하는 것들을 보면서 참 많이 돌아보게 되는 것 같다.

 

 

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

닫기

해당 상품을 장바구니에 담았습니다.이미 장바구니에 추가된 상품입니다.
장바구니로 이동하시겠습니까?