API 레퍼런스 문서 작성 중단하고 요리책을 쓰기 시작했더니 참여도 세 배 증가
(dev.to)API 레퍼런스 대신 개발자의 문제 해결 중심인 '요리책(Cookbook)' 방식의 문서를 도입하여 첫 API 호출 시간을 40분에서 6분으로 단축시키고 사용자 참여도를 3배 증가시킨 혁신적인 개발자 경험(DX) 개선 사례를 분석합니다.
이 글의 핵심 포인트
- 1API 레퍼런스는 사전(Dictionary)과 같아 사용자가 문제를 해결할 때만 찾아보게 됨
- 2요리책 방식은 목표, 전제 조건, 단계별 코드, 전체 실행 스크립트를 포함한 작업 중심 구조임
- 3문서 전환 후 첫 API 호출 시간이 약 40분에서 6분으로 대폭 단축됨