Hyperdocs icon

Hyperdocs

Hyperdocs 是一款面向 SaaS 团队的 AI 文档平台,可根据代码库生成并持续维护产品文档,支持 GitHub 同步、公共文档、帮助中心、API 文档和更新日志。

Hyperdocs

概览

Hyperdocs 是一款面向 SaaS 团队的 AI 文档平台,可根据代码库创建并持续维护面向公众的产品文档。它适用于产品文档、帮助中心、API 文档和更新日志,并通过将代码变更转化为供人工审阅的文档草稿来实现工作流。

该产品可连接 GitHub,扫描仓库变更,并建议哪些页面需要关注。它还可以基于现有代码库生成文档草稿,设计上支持团队在任何内容发布前进行审阅、编辑和批准。

功能

GitHub 同步与变更检测

连接 GitHub 仓库,让 Hyperdocs 检测代码变更、识别可能需要更新的文档,并生成可供审阅的修订草稿。

代码到文档生成

从代码库生成可编辑草稿,包括产品文档、安装指南、API 参考和帮助文章。

多文档模块

在同一工作区内发布产品文档、帮助中心、API 文档和更新日志,而无需管理多个独立工具。

公共文档发布与品牌化

发布带有可搜索的公共文档,具备面向 SEO 的结构、元数据、快速页面,并支持自定义域名和品牌导航。

搜索、分析与反馈

查看用户搜索了什么、阅读了什么、错过了什么以及难以找到什么,并收集反馈以发现文档缺口。

AI 辅助文档工作流

使用内置的 AI Answer Agent 和 Docs Agent,帮助回答问题并编写或更新文档内容。

使用场景

  • 从代码库创建文档

    连接前端或产品仓库,在从零开始时创建产品文档、安装说明和功能说明的可编辑草稿页面。

  • 在产品变更发布时维护文档

    通过审阅 GitHub 变更、查看哪些页面可能受影响,并在批准后发布更新,让文档与产品发布保持一致。

  • 构建帮助中心

    为需要答案而不想提交支持工单的用户发布可搜索的自助文章,并利用帮助中心格式和反馈工具发现缺口。

  • 发布 API 文档

    在与产品文档和更新日志相同的工作区内,使用参考、指南和示例记录 API。

  • 迁移现有文档站点

    将现有文档导入 Hyperdocs,保留结构,并在平台内继续编辑和发布,而不是手动迁移。

Pros and Cons

Pros

  • 可从代码生成文档草稿,能减少新文档或更新内容时的人工初稿工作。
  • 与 GitHub 同步,使文档能够更紧密地跟踪产品变更。
  • 在一个平台内支持多种公共文档格式,包括产品文档、帮助中心内容、API 文档和更新日志。
  • 提供发布前审阅控制,而不是自动发布 AI 输出。
  • 提供分析、反馈和搜索数据,帮助团队识别文档缺口。

Cons

  • 定价页面显示了使用限制和按方案区分的功能差异,因此部分能力取决于所选工作区方案。
  • 面向企业和商务工作流的功能,例如审批工作流、高级集成以及部分 Agent 功能,被标注为即将推出、抢先体验或定制,而非普遍可用。

FAQ

什么是 Hyperdocs?

Hyperdocs 是一款面向 SaaS 团队的 AI 原生文档平台,旨在生成、发布并持续维护产品文档、帮助中心、API 文档和更新日志。

Hyperdocs 可以从 GitHub 生成文档吗?

是的。Hyperdocs 可连接 GitHub 仓库,理解代码结构和变更,并基于这些源内容创建可编辑的文档草稿。

Hyperdocs 会自动发布 AI 生成的文档吗?

不会。Hyperdocs 会生成草稿和建议,但最终文档需要由你的团队进行审阅、编辑、批准并发布。

我可以把现有文档迁移到 Hyperdocs 吗?

可以。价格页面说明,现有文档可以导入到 Hyperdocs 中,因此团队无需从头重建文档。

Hyperdocs 只用于内部文档吗?

Hyperdocs 主要面向面向公众的 SaaS 文档,包括产品文档、帮助中心、API 文档和更新日志。

Quick Facts

类别
AI 文档平台
主要用户
SaaS 团队
核心工作流
从代码生成文档、与 GitHub 同步、审阅草稿,然后发布
文档类型
产品文档、帮助中心、API 文档、更新日志
定价形式
免费套餐加付费套餐;企业版和商务版可联系获取
官方网站
hyperdocs.io