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

한빛미디어

독자리뷰

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

yee0***

|

2023-05-28

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

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

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

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

 

이 책에서 눈에 띄는 주제 중 하나는 "지식의 저주"라는 개념입니다. 주제에 대해 이미 깊이 알고 있는 상태에서 다른 사람에게 무언가를 설명하는 것이 어렵다는 것을 의미합니다. 이 책은 이 저주를 인식하고 작가와 독자 사이의 이해 격차를 해소하기 위한 조처를 하는 것의 중요성을 강조합니다. 명확한 설명을 제공하고 전문 용어나 가정을 피함으로써 기술 문서 작성시 자신의 문서를 다양한 청중이 액세스할 수 있도록 할 수 있습니다.

 

 

이 책은 또한 기술 문서 작성의 협업적 특성을 강조합니다. 어떤 문서도 고립되어 존재하지 않는다는 사실을 강조합니다. IT 환경에서는 상호 연결된 여러 문서가 있는 경우가 많으며 독자를 관련 자원으로 안내하고 필요한 정보에 쉽게 액세스할 수 있도록 하는 것이 중요합니다. 문서를 효과적으로 구성하고 탐색 요소를 통합함으로써 작성자는 독자가 원활하게 탐색하고 혼란이나 좌절 없이 원하는 정보를 찾을 수 있도록 도울 수 있습니다.

 

 

또한 이 책은 문서가 발전하고 정기적으로 업데이트되어야 할 필요성을 강조합니다. 기술은 끊임없이 변화하고 있으며 오래되었거나 부정확한 문서는 혼란과 오류로 이어질 수 있습니다. 기술 문서는 독자가 자신의 문서에 두는 신뢰를 염두에 두고 제공된 정보가 신뢰할 수 있도록 해야 합니다. 문서 작성 및 유지 관리는 시간이 많이 소요될 수 있지만 효과적인 의사소통을 지원하고 사용자 간의 신뢰를 조성하는 것은 필수적인 책임입니다.

 

 

결과적으로 기술 전문성 수준에 관계없이 기술 문서 작성에 관련된 모든 사람에게 유용한 책입니다. 특히 IT, 오픈 API 명세를 작성하는 분에게 적합합니다.

 

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

닫기

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