이 문서는 카카오디벨로퍼스 문서에 대한 정보를 제공하고, 문서 추가 및 수정과 같은 협업에 필요한 사항을 안내합니다.

카카오디벨로퍼스 문서는 카카오디벨로퍼스에서 제공하는 제품을 위한 기술 문서입니다. 카카오디벨로퍼스 상단 메뉴의 [문서] 메뉴에서 모든 사용자를 위한 오픈 문서, 카카오 및 공동체를 위한 인하우스/공동체 문서 두 가지를 제공합니다.

오픈 문서는 카카오디벨로퍼스의 모든 사용자를 위한 문서입니다. 카카오 로그인, 카카오톡 공유, 카카오톡 소셜 등 다양한 오픈 API 제품 사용에 필요한 정보를 제공합니다.

인하우스/공동체 문서는 카카오 및 공동체 사용자를 위한 문서입니다. 인하우스/공동체 문서는 카카오 및 공동체에서만 사용 가능한 기능의 문서를 다루기 때문에 사내망에서만 접근 가능합니다.

카카오디벨로퍼스 문서는 로그인, 커뮤니케이션과 같은 카테고리 하위에 각 제품 문서를 포함합니다. 각 제품 문서는 주제별 문서로 나뉩니다. 아래는 기본적인 제품별 문서 구성이며, 제품 특징에 따라 추가 문서를 포함할 수 있습니다.

카카오디벨로퍼스 문서는 일반 텍스트 기반의 마크업 언어인 마크다운(.md)으로 작성합니다. 카카오디벨로퍼스의 문서 모듈은 마크다운 파일(.md)을 HTML 파일(.html)로 변환해 제공하므로, 일부 HTML 태그를 사용한 이미지 삽입, 꾸미기, 주석 추가 등이 가능합니다.

문서 저장소로는 사내 Github를 사용합니다. 오픈가이드와 인하우스가이드의 문서 리포지토리(Repository)는 분리되어 있으며, 모두 비공개 리포지토리이므로 권한이 있어야 접근 가능합니다.

Kakao SDK 레퍼런스의 경우, 주석을 기반으로한 문서 자동화 도구로 생성됩니다. 주석은 일관된 정보를 제공하기 위해 카카오디벨로퍼스 문서에서 문구를 발췌하거나, 개발 중 논의를 거쳐 문서와 레퍼런스를 같은 내용으로 관리됩니다.

카카오디벨로퍼스 문서에 새로운 제품 문서를 추가하거나, 기존 문서를 수정하려면 [서비스] API플랫폼 아지트로 요청합니다.

• 서비스 담당자
  • [서비스] API플랫폼 아지트에 문서 작업 요청
  • 희망 배포 일정으로부터 최소 2주 전 요청 권장
• API플랫폼
  • 예상 작업 일정 답변, 작업 관련 문의, 자료 요청

• API플랫폼
  • 문서 작업 산출물에 대한 서비스 담당자의 검토 요청
• 서비스 담당자
  • 사내망에서만 접근 가능한 개발 서버로 문서 작업 산출물 검토 가능
  • 검토 요청으로부터 5 업무일 이내에 검토 의견 전달 권장

• API플랫폼
  • 검토 의견 반영 후 서비스 담당자의 최종 확인 요청
• 서비스 담당자
  • 희망 배포 일정으로부터 3 업무일 전까지 추가 검토 의견 전달 및 최종 확인 권장
  • 최종 확인 후에는 개발 서버에서 문서 작업 산출물을 조회할 수 없음

• API플랫폼
  • 최종 확인이 완료된 문서를 희망 배포 일정에 따라 배포
• 서비스 담당자
  • 배포된 문서 확인

https://developers.kakao.com/${DOC_TYPE}/${VERSION}/${LANGUAGE}/${PRODUCT_NAME}/${FILE_NAME}#${ID}