DocC로 iOS 개발 생산성 UP! 올리브영의 문서 자동화 노하우 공개
by DD
1년 전
조회수 10
DocC는 Apple의 공식 문서화 도구로, 코드 주석 기반 문서를 자동 생성한다.
올리브영은 DocC 도입 후 문서 관련 문의 90% 감소 및 개발 생산성 향상을 경험했다.
GitHub Pages를 활용하여 DocC 문서를 웹에 배포하고, 협업 효율성을 높였다.
DocC, Xcode 내장 문서화 도구
DocC는 Xcode13부터 지원하는 Apple의 공식 문서화 도구이다. 주석 기반 문서 자동 생성을 통해 개발 생산성을 향상시킨다. 구체적으로, 마크다운과 주석을 활용하여 API 문서, 튜토리얼, 사용 예제를 작성할 수 있다. 따라서, 코드와 문서의 동기화를 유지하며 유지보수 비용을 절감한다.
올리브영의 DocC 도입 효과
올리브영은 DocC 도입 후 로컬 빌드 관련 문의 90% 감소라는 놀라운 성과를 거두었다. JavaScript Interface 가이드를 DocC로 작성하여, 인터페이스 관련 문의 75% 감소를 달성했다. 반면, DocC는 Xcode에 종속적이므로, IDE 환경 제약이 존재한다.
DocC 문서 배포 및 활용 전략
DocC 문서는 GitHub Pages를 통해 웹에 배포하여 접근성을 높일 수 있다. 구체적으로, GitHub Actions를 활용하여 자동 배포 파이프라인을 구축한다. 따라서, 오픈소스 프로젝트나 팀 협업 시 API 문서 공유를 통해 개발 효율을 극대화할 수 있다.
