Documate

Documate는 문서 웹사이트의 사용자 경험을 크게 향상시키기 위해 설계된 혁신적인 오픈 소스 솔루션입니다. 강력한 AI 기반 채팅 인터페이스를 사이트에 원활하게 통합하여 최종 사용자가 대화 방식으로 문서와 상호 작용할 수 있도록 합니다. 이 기능을 통해 사용자는 자연어로 질문하고 콘텐츠에서 직접 파생된 정확하고 실시간 답변을 받을 수 있습니다. 본질적으로 Documate는 특정 지식 기반으로 훈련된 프로젝트 전용 'ChatGPT'를 생성합니다. 이 도구는 개발자를 염두에 두고 제작되었으며, 통합의 용이성, 데이터에 대한 완전한 제어 및 광범위한 사용자 정의 옵션을 우선시합니다.

Documate 사용 방법

Documate 설정은 개발자를 위해 설계된 간단한 과정입니다:

1. 백엔드 설정: GitHub 리포지토리에서 제공되는 서버리스 백엔드 함수를 AirCode와 같은 클라우드 플랫폼에 배포하는 것으로 시작합니다. 이는 종종 한 번의 클릭으로 수행될 수 있습니다.
2. 환경 구성: 백엔드 환경 설정에서 OPENAI_API_KEY를 설정해야 합니다. 이 키는 OpenAI API가 콘텐츠를 처리하고 사용자 쿼리에 대한 답변을 생성하는 데 필수적입니다.
3. 백엔드 배포: 구성 후 함수를 배포합니다. 이렇게 하면 upload 및 ask API 엔드포인트에 대한 고유한 URL이 제공됩니다.
4. 프론트엔드 통합: 선호하는 문서 프레임워크(예: VitePress, Docusaurus, Docsify)를 선택합니다. npm create documate@latest 명령을 사용하여 Documate가 이미 구성된 새 프로젝트를 스캐폴딩하거나 기존 사이트에 수동으로 통합할 수 있습니다.
5. Documate 구성: 프로젝트의 루트 디렉토리에 documate.json 파일을 만듭니다. 이 파일에서 백엔드 업로드 엔드포인트 URL을 지정하고 인덱싱에 포함하거나 제외할 콘텐츠 파일(예: 마크다운 파일)을 정의합니다.
6. 콘텐츠 업로드: 지정된 업로드 명령을 실행합니다. 이렇게 하면 문서 콘텐츠가 백엔드로 전송되어 처리되고 프로젝트의 검색 가능한 지식 기반으로 변환됩니다.
7. 실행: 설정이 완료되면 문서 사이트에 지능형 AI 채팅 도우미가 장착되어 사용자를 도울 준비가 됩니다.

Documate의 핵심 기능

• AI 기반 Q&A: 인덱싱된 문서를 기반으로 사용자 질문에 즉각적이고 상황에 맞는 답변을 제공하는 채팅 다이얼로그를 구현합니다.
• 원활한 프레임워크 통합: VitePress, Docusaurus, Docsify, Rspress 및 Nextra를 포함한 인기 있는 정적 사이트 생성기에 대한 즉시 사용 가능한 지원 및 스타터 템플릿을 제공합니다.
• 서버리스 백엔드: 모든 콘텐츠 인덱싱 및 질문 응답 로직을 처리하기 위해 가볍고 쉽게 배포할 수 있는 서버리스 함수 세트를 활용합니다.
• 완전한 데이터 및 코드 제어: 완전한 오픈 소스 도구로서 코드와 데이터에 대한 완전한 소유권을 부여합니다. 어떤 콘텐츠를 인덱싱하고 백엔드 인프라를 어디에 호스팅할지 제어할 수 있습니다.
• 높은 사용자 정의 가능성: CSS를 사용하여 완전히 사용자 정의할 수 있는 세련된 기본 사용자 인터페이스와 함께 제공되어 브랜드의 고유한 모양과 느낌에 맞출 수 있습니다.
• 접근성 우선 설계: 접근성을 우선으로 설계되어 완전한 키보드 탐색을 지원하고 스크린 리더와 호환되며 최신 웹 표준을 준수합니다.
• 간단한 구성: 단일의 간단한 documate.json 파일을 사용하여 모든 프로젝트별 설정을 관리하여 구성 프로세스를 단순화합니다.

Documate의 사용 사례

Documate는 다재다능하며 다양한 시나리오에 적용될 수 있습니다:

• 소프트웨어 문서: SaaS 제품 문서, 오픈 소스 프로젝트 매뉴얼 또는 API 참조를 향상시켜 개발자가 페이지를 떠나지 않고도 즉시 답변을 찾을 수 있도록 합니다.
• 내부 지식 기반: 회사의 내부 위키나 문서 사이트에 배포하여 직원들이 회사 프로세스, 정책 및 기술 가이드에 대한 정보를 신속하게 찾을 수 있도록 돕습니다.
• 교육 플랫폼: 온라인 코스 자료나 e-러닝 웹사이트에 통합하여 학생들이 의문점을 해소하고 즉각적인 도움을 받을 수 있는 대화형 방법을 제공합니다.
• 고객 지원 포털: 일반적인 고객 질문을 자동으로 해결할 수 있는 셀프 서비스 AI 도우미를 도움말 센터 및 FAQ 페이지에 배포하여 지원 티켓의 양을 줄입니다.

Documate의 장점

• 향상된 사용자 경험: 사용자가 정보를 찾는 데 소요되는 시간을 대폭 줄여 즉각적인 답변을 제공하고 사용자 만족도와 참여도를 크게 향상시킵니다.
• 개발자 친화적: 빠른 설정 및 통합을 위해 설계되었으며 AI, 대규모 언어 모델(LLM) 또는 벡터 데이터베이스에 대한 전문 지식이 필요하지 않습니다.
• 오픈 소스 및 무료: 핵심 도구는 오픈 소스 라이선스에 따라 사용, 수정 및 배포가 완전히 무료이므로 소프트웨어 라이선스 비용이 없습니다.
• 개인 정보 보호 중심: 백엔드를 호스팅하고 전체 데이터 흐름을 제어하여 잠재적으로 민감한 문서 콘텐츠가 비공개로 안전하게 유지되도록 합니다.
• 비용 효율적: 서버리스 함수를 활용하고 기본 API 사용량(예: OpenAI)에 대해서만 비용을 지불함으로써 독점적인 엔터프라이즈 솔루션에 비해 훨씬 낮은 운영 비용으로 강력한 AI 기능을 구현할 수 있습니다.

가격 및 플랜

Documate 자체는 GitHub에서 사용할 수 있는 완전한 무료 및 오픈 소스 도구입니다. 소프트웨어 사용에 대한 라이선스 비용은 없습니다. 그러나 Documate를 실행하려면 타사 서비스의 운영 비용이 발생합니다:

• LLM API 비용: 자체 OpenAI API 키를 제공해야 합니다. 콘텐츠 임베딩 및 사용자 질문에 대한 답변 사용량에 따라 OpenAI에서 직접 청구됩니다.
• 백엔드 호스팅 비용: 서버리스 백엔드는 AirCode, Vercel 또는 Netlify와 같은 플랫폼에서 호스팅해야 합니다. 이러한 플랫폼은 일반적으로 넉넉한 무료 등급을 제공하지만 사용량이 무료 한도를 초과하면 비용이 발생할 수 있습니다.

요약하자면, Documate 소프트웨어는 무료이지만 총 소유 비용은 문서의 크기와 채팅 도우미가 받는 트래픽에 따라 달라집니다.