Documate

Documate 是一款創新的開源解決方案，旨在顯著提升文件網站的使用者體驗。它將一個強大的、由人工智能驅動的聊天介面無縫整合到您的網站中，允許終端使用者以對話的方式與您的文件進行互動。此功能使他們能夠用自然語言提問，並獲得直接從您的內容中提取的準確、即時的答案。從本質上講，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，並定義應包含或排除哪些內容檔案（例如 Markdown 檔案）進行索引。
6. 上傳內容： 執行指定的上傳命令。這會將您的文件內容傳送到後端，在那裡它將被處理並轉換為您專案的可搜尋知識庫。
7. 啟動： 設定完成後，您的文件網站現在就配備了一個智慧型 AI 聊天助理，隨時可以幫助您的使用者。

Documate 的核心功能

• AI 問答： 實現一個聊天對話框，根據索引的文件內容，為使用者問題提供即時、上下文相關的答案。
• 無縫框架整合： 為 VitePress、Docusaurus、Docsify、Rspress 和 Nextra 等流行的靜態網站生成器提供開箱即用的支援和入門範本。
• 無伺服器後端： 利用一套輕量級、易於部署的無伺服器函式來處理所有內容索引和問答邏輯。
• 完全的數據和程式碼控制： 作為一個完全開源的工具，它讓您完全擁有您的程式碼和數據。您可以決定哪些內容被索引以及您的後端託管在何處。
• 高度可客製化： 提供一個精緻的預設使用者介面，該介面可以使用 CSS 進行完全客製化，讓您能夠匹配您品牌的獨特外觀和感覺。
• 無障礙優先設計： 以可及性為優先進行設計，支援完整的鍵盤導覽並與螢幕閱讀器相容，遵循現代網路標準。
• 簡化配置： 使用一個簡單明瞭的 documate.json 檔案來管理所有專案特定的設定，簡化了配置過程。

Documate 的使用案例

Documate 功能多樣，可應用於各種場景：

• 軟體文件： 增強 SaaS 產品文件、開源專案手冊或 API 參考，讓開發人員無需離開頁面即可即時找到答案。
• 內部知識庫： 部署在公司內部的維基或文件網站中，幫助員工快速查找有關公司流程、政策和技術指南的資訊。
• 教育平台： 整合到線上課程材料或電子學習網站中，為學生提供一種互動方式來澄清疑問並獲得即時幫助。
• 客戶支援入口網站： 透過在幫助中心和常見問題頁面上部署一個自助服務 AI 助理，自動解決常見的客戶問題，從而減少支援工單的數量。

Documate 的優勢特點

• 改善使用者體驗： 大大減少使用者搜尋資訊的時間，提供即時答案，顯著提高使用者滿意度和參與度。
• 開發者友善： 專為快速設定和整合而設計，無需人工智能、大型語言模型（LLM）或向量資料庫方面的專業知識。
• 開源免費： 核心工具完全免費使用、修改和分發，無需任何軟體授權費用。
• 注重隱私： 您可以自己託管後端並控制整個數據流，確保您潛在的敏感文件內容保持私密和安全。
• 成本效益高： 透過利用無伺服器函式並僅為底層 API 使用（例如 OpenAI）付費，您可以用比專有企業解決方案低得多的營運成本實現強大的 AI 功能。

定價和計劃

Documate 本身是一個完全免費的開源工具，可在 GitHub 上取得。使用該軟體無需支付任何授權費用。但是，執行 Documate 會涉及來自第三方服務的營運成本：

• LLM API 成本： 您必須提供自己的 OpenAI API 金鑰。OpenAI 將根據您嵌入內容和回答使用者問題的使用情況直接向您收費。
• 後端託管成本： 無伺服器後端需要託管在像 AirCode、Vercel 或 Netlify 這樣的平台上。這些平台通常提供慷慨的免費方案，但如果您的使用量超過免費限制，則可能會產生費用。

總而言之，雖然 Documate 軟體是免費的，但總擁有成本取決於您的文件規模和聊天助理的流量。