DeepDocs

DeepDocs는 GitHub AI 에이전트로, 기술 문서를 코드베이스와 완벽하게 동기화 상태로 유지합니다. 코드 변경 사항을 커밋하면 전체 저장소를 스캔하여 업데이트가 필요한 문서를 찾아 자동으로 필요한 변경을 수행합니다.

기존의 문서 생성기가 파일을 처음부터 만드는 것과 달리, DeepDocs는 변경이 필요한 부분만 업데이트하며 원래의 스타일과 형식을 그대로 유지합니다. Docusaurus, Mintlify, MkDocs, Read the Docs와 같은 인기 문서 도구와 호환됩니다.

DeepDocs는 개인 프로젝트를 위한 무료 버전을 제공하며, 매월 10회의 스캔 크레딧이 포함되어 있습니다. 또한, 자주 코드를 배포하는 팀을 위한 Pro 버전도 제공하며, 매월 100회의 스캔 크레딧과 최대 다섯 개의 문서 파일 또는 폴더를 동시에 지원합니다.

DeepDocs 시작은 간단하며 약 2분 정도 소요됩니다. 다음은 단계별 안내입니다:

• GitHub 마켓플레이스에서 DeepDocs 애플리케이션을 소스 코드와 문서가 포함된 저장소에 설치하세요. 문서가 별도의 저장소에 있다면 그곳에도 설치하세요.

• 메인 브랜치의 루트에 deepdocs.yml이라는 구성 파일을 만드세요. 이 파일은 DeepDocs에 어떤 문서 파일이나 폴더를 코드와 동기화할지 알려줍니다.

• 구성 파일을 저장소에 커밋하세요. DeepDocs는 즉시 코드베이스를 완전히 스캔하여 오래된 문서를 감지하고, 제안된 수정 사항이 포함된 상세 이메일 보고서를 보냅니다.

• 초기 설정 후, DeepDocs는 이후 모든 커밋에서 자동으로 작동하여 변경 사항을 스캔하고, 검토를 위해 병합 전에 별도의 브랜치에서 관련 문서를 업데이트합니다.

• 커밋마다 자동 문서 업데이트

• 코드 변경 시 전체 저장소 스캔

• 서식은 유지하면서 오래된 섹션만 업데이트

• 문서 변경 사항에 대한 상세 보고서

• 풀 리퀘스트 워크플로우와 GitHub 네이티브 통합

• 모노레포 및 별도 문서 저장소 지원

• Docusaurus, Mintlify, MkDocs, Read the Docs 지원

• 전체 재작성 없이 지능형 업데이트

• 스캔 결과 이메일 알림

• 간편한 2분 설정 과정