[Book Review] Docs for Developers (기술 문서 작성 완벽 가이드)
개발자를 위한 문서는 개발자 경험을 향상시키고 제품의 채택률을 높이며 고객 지원 비용을 낮춰준다고 한다. 또한 장기적으로는 제품의 평판을 높이고 경쟁 우위를 제공하여 사업의 성공에 중요한 역할을 한다고 한다. 개발자 문서를 잘 만들고 관리하는 방법은 무엇일까? 이 책에서는 문서화 하기 전 독자 이해하기, 문서화 계획하기, 초안 만들기, 편집 하기, 샘플 코드 통합하기, 시각적 콘텐츠 추가하기, 문서 배포하기, 피드백 수집하고 통합하기, 문서 품질 측정하기, 문서 구조화 하기, 문서 유지 관리 및 지원 중단하기 까지 개발자 문서를 완벽하게 만들기 위한 가이드를 End-to-End로 제공한다. 코드 자체가 잘 작성된다면 그 자체로 문서화가 된다는데, 복잡성과 규모가 일정 수준 이상인 프로젝트에서는 코드 레벨..
2023.05.25
