DeepDocs
DeepDocs이란?
DeepDocs는 진화하는 코드베이스와 기술 문서를 동기화하는 프로세스를 자동화하려는 개발 팀을 위해 설계된 GitHub 네이티브 AI 에이전트입니다. 이 에이전트는 코드 변경 사항을 자동으로 스캔하고 README, API 참조, SDK 가이드, 튜토리얼과 같은 관련 문서를 업데이트하여 오래된 문서 문제를 해결합니다. DeepDocs의 핵심 가치는 수동적이고 시간이 많이 소요되는 문서 업데이트 작업을 없애 개발자가 코드 출하에 집중하면서 문서의 정확성과 최신 상태를 유지할 수 있도록 하는 것입니다. GitHub 워크플로에 직접 통합되어 지능적이고 개인 정보 보호를 우선하는 업데이트를 제공합니다.
DeepDocs 사용 방법
사용자는 GitHub Marketplace에서 DeepDocs 앱을 자신의 저장소에 설치하여 시작할 수 있습니다. 설치 후, 저장소 루트에 있는 `deepdocs.yml` 파일에 추적할 문서 파일 또는 폴더를 정의하여 DeepDocs를 구성해야 합니다. 이 YAML 파일을 커밋하면 초기 딥 스캔이 트리거되고 별도의 브랜치에서 오래된 문서가 업데이트됩니다. 이후 모든 코드 커밋은 지속적인 문서 업데이트를 자동으로 트리거합니다. DeepDocs는 개인 또는 오픈 소스 프로젝트를 위한 제한된 크레딧의 무료 플랜을 제공하며, 더 많은 크레딧과 기능을 포함하는 'Pro' 플랜이 곧 출시될 예정입니다.
DeepDocs의 주요 기능
지속적인 문서화
딥 스캔
지능형 업데이트
상세 보고서
GitHub 네이티브
개인 정보 보호 우선
DeepDocs의 사용 사례
코드 변경 시 README 파일을 자동으로 업데이트합니다.
API 코드 수정 사항에 맞춰 API 참조 문서를 동기화합니다.
SDK 가이드가 최신 라이브러리 버전 및 기능을 반영하도록 보장합니다.
기본 코드가 진화함에 따라 최신 튜토리얼을 유지합니다.
개발 팀의 수동 문서 업데이트를 없앱니다.
단일 스캔으로 전체 저장소의 문서 정확성을 보장합니다.
기존 GitHub 워크플로에 문서 업데이트를 원활하게 통합합니다.
코드 커밋으로 인한 문서 변경 사항에 대한 명확한 보고서를 제공합니다.
DeepDocs에 대한 자주 묻는 질문
DeepDocs는 어떤 기능을 하나요?
DeepDocs는 GitHub 네이티브 AI 에이전트로, API 문서, SDK 가이드, 튜토리얼 등을 코드베이스와 자동으로 동기화합니다. 코드 변경 사항을 감지하고, 오래된 문서를 찾아내며, 상세 보고서와 함께 별도의 브랜치에서 업데이트를 수행합니다.
DeepDocs가 문서를 처음부터 생성하나요?
DeepDocs는 기존 문서를 유지 관리하도록 설계되었으며, 처음부터 생성하지는 않습니다. 문서가 전혀 없는 상태에서 시작하는 경우, GitHub Copilot, Cursor 등과 같은 AI 코드 도구가 초기 버전을 작성하는 데 도움을 줄 수 있습니다. 문서가 일단 준비되면 DeepDocs는 모든 커밋마다 자동으로 업데이트하여 코드베이스와 동기화 상태를 유지합니다.
제 저장소에 DeepDocs를 어떻게 설정할 수 있나요?
DeepDocs는 세 가지 간단한 단계로 설정할 수 있습니다: 1. GitHub Marketplace에서 앱을 설치합니다; 2. deepdocs.yml 파일에 추적하려는 대상 문서 파일 또는 폴더를 지정합니다; 3. 저장소 루트에 파일을 커밋하여 딥 스캔을 트리거하고 손상된 문서를 업데이트합니다. 향후 커밋은 문서 업데이트를 자동으로 트리거합니다.
DeepDocs가 제 문서 구조나 스타일을 변경하나요?
아니요. DeepDocs는 문서의 관련 부분만 지능적으로 업데이트합니다. 기존 형식을 보존하며 파일을 처음부터 다시 작성하지 않습니다.
딥 스캔과 문서 업데이트의 차이점은 무엇인가요?
딥 스캔은 DeepDocs 기능으로, 저장소 전체를 분석하여 오래된 문서를 한 번에 감지하고 수정하는 기능이며 수동으로 트리거할 수 있습니다. 문서 업데이트는 모든 커밋에서 트리거되는 지속적인 문서화 기능으로, 영향을 받는 문서만 식별하고 업데이트합니다.
DeepDocs에서 크레딧은 어떻게 소모되나요?
DeepDocs는 딥 스캔에 1크레딧, 문서 업데이트 프로세스에 1크레딧을 사용합니다.
Cursor나 Copilot 같은 AI 코딩 에이전트도 문서를 생성할 수 있지 않나요?
그럴 수 있지만, 수동으로 업데이트할 내용을 프롬프트해야만 가능합니다. DeepDocs는 다르게 작동합니다. CI/CD가 수동 배포를 대체했듯이, DeepDocs는 수동 문서 업데이트를 대체하여 워크플로에 지속적인 문서화를 제공합니다. 또한 전체 코드-문서 컨텍스트를 사용하여 어떤 내용이 변경되었고 어떤 문서가 영향을 받는지 프롬프트 없이도 알 수 있습니다.