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 软件是免费的，但总拥有成本取决于您的文档规模和聊天助手的流量。