iOS 개발자를 위한 DocC 실무 튜토리얼

올리브영 iOS 개발팀은 기존 Confluence를 활용한 문서화 방식에서 발생하는 코드와 문서 간의 불일치 문제를 해결하기 위해 Apple의 공식 문서화 도구인 DocC를 도입했다.

DocC를 도입함으로써 코드 리뷰 프로세스에 문서 업데이트를 포함시켜 문서의 최신성을 강제할 수 있게 되었으며, 이는 팀 내 소통 비용을 낮추는 결과로 이어졌다.

DocC의 주요 장점은 다음과 같다:

• 문서 자동화: 주석(///)과 Markdown을 기반으로 API 문서를 자동 생성하여 유지보수 비용을 절감한다.
• 직관적 인터페이스: Xcode 내에서 검색 기능과 함께 구조화된 API 문서를 즉시 확인할 수 있다.
• 다양한 포맷 지원: 단순 API 명세를 넘어 Markdown을 활용한 튜토리얼 및 개념 설명 작성이 가능하다.
• 협업 및 배포 용이성: HTML 형태로 문서를 생성하여 GitHub Pages 등을 통해 외부 개발자와도 쉽게 공유할 수 있다.

사용 방법은 Xcode에서 Documentation Catalog를 생성하는 것으로 시작하며, Markdown 파일을 통해 상세한 튜토리얼과 메타데이터를 구성할 수 있다.