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

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

 

Docs for Developers 기술 문서 작성 완벽 가이드는 Corg.ly라는 가상의 서비스를 만드는 개발 팀에 대한 이야기를 들려주고 있다. Corg.ly 는 강아지 음성을 인간의 언어로 번역하는 서비스이다. API를 사용하여 번역을 요청하고 번역 결과를 받으며, 머신 러닝 모델을 사용하여 정기적으로 번역을 개선한다. 

그리고 이 책에서는 특정 도구나 프레임워크를 다루지 않는다. 문서를 특정 마크업 언어로 작성하거나 특정 CI, 지속적 통합 도구로 자동 업데이트되는 특정 정적 사이트 생성기로 문서를 게시하는 방법을 알려주지 않는것에 대해 실망스러워하실 분도 있을 수 있다. 하지만 이렇게 한 이유는 문서화에 가장 효과적인 언어와 도구는 독자가 작성하는 코드 및 개발 도구와 밀접한 연관이 있고, 이는 독자가 처한 환경에 따라 달라지기 때문이라고 설명한다. 

 

도구 선택에 대한 지침이 추가로 필요한 독자를 위해 책의 끝에서는 요구 사항에 맞는 문서화 도구와 추가 정보를 찾는 데 사용할 수 있는 자료를 부록으로 제공하고 있다. 

 

Corg.ly 서비스를 출시하고 운영하는 과정을 팔로우하면서 개발자 문서 작성 방법을 쉽고 재밌게 배울수 있었다. 

 

700