Hyperdocs icon

Hyperdocs

Hyperdocs 是一個 AI 文件平台,專為 SaaS 團隊打造,能從 codebase 產生並維護產品文件,並與 GitHub 同步,支援公開文件、說明中心、API 文件與更新紀錄。

Hyperdocs

概覽

Hyperdocs 是一個 AI 文件平台,專為 SaaS 團隊打造,能從 codebase 產生並維護對外公開的產品文件。它適用於產品文件、說明中心、API 文件與更新紀錄,並透過將程式碼變更轉換為可供人工審閱的文件草稿來運作。

此產品可連接 GitHub、掃描 repository 變更,並建議哪些頁面需要關注。它也能從既有的 codebase 產生文件草稿,且設計上讓團隊在發布前先審閱、編輯並核准變更。

功能

GitHub 同步與變更偵測

連接 GitHub repository,讓 Hyperdocs 能偵測程式碼變更、識別可能需要更新的文件,並起草修訂內容供審閱。

從程式碼到文件的產生

從 codebase 產生可編輯草稿,包括產品文件、設定指南、API 參考與說明文章。

多種文件模組

從單一工作區發布產品文件、說明中心、API 文件與更新紀錄,不必分別管理多個工具。

公開文件發布與品牌設定

新增可搜尋的公開文件,具備符合 SEO 的結構、metadata、快速頁面,並支援自訂網域與品牌化導覽。

搜尋、分析與回饋

查看使用者搜尋什麼、閱讀了什麼、找不到什麼、以及哪些內容難以找到,並蒐集回饋以找出文件缺口。

AI 輔助文件工作流程

使用內建的 AI Answer Agent 與 Docs Agent,協助回答問題以及撰寫或更新文件內容。

使用情境

  • 從 codebase 建立文件

    連接前端或產品 repository,從零開始建立可編輯的產品文件、設定說明與功能說明草稿頁面。

  • 隨著產品變更持續維護文件

    透過檢視 GitHub 變更、了解哪些頁面可能受影響,並在核准後發布更新,讓文件與產品發佈保持一致。

  • 建立說明中心

    為不想開啟支援單的使用者發布可搜尋的自助式文章,並利用說明中心格式與回饋工具找出缺口。

  • 發布 API 文件

    在與產品文件和更新紀錄相同的工作區中,以參考文件、指南與範例來記錄 API。

  • 遷移既有文件網站

    將既有文件匯入 Hyperdocs,保留結構,並在平台內持續編輯與發布,而不必手動遷移。

Pros and Cons

Pros

  • 可從程式碼產生文件草稿,能減少新文件或更新時的人工初稿工作。
  • 與 GitHub 同步,讓文件更能緊跟產品變更。
  • 在同一平台支援多種公開文件格式,包括產品文件、說明中心內容、API 文件與更新紀錄。
  • 提供發布前審閱控制,而不是自動發布 AI 輸出內容。
  • 提供分析、回饋與搜尋資料,協助團隊找出文件缺口。

Cons

  • 價格頁面顯示有使用量限制與依方案而異的功能差異,因此某些功能是否可用取決於所選的工作區方案。
  • 商務與企業級工作流程,例如核准流程、進階整合以及部分 Agent 功能,被列為即將推出、搶先體驗或客製化,而非全面開放。

FAQ

什麼是 Hyperdocs?

Hyperdocs 是一個 AI 原生文件平台,專為 SaaS 團隊打造。它的設計用途是產生、發布並維護產品文件、說明中心、API 文件與更新紀錄。

Hyperdocs 可以從 GitHub 產生文件嗎?

是的。Hyperdocs 會連接到 GitHub repository,理解程式碼結構與變更,並可根據該來源建立可編輯的文件草稿。

Hyperdocs 會自動發布 AI 產生的文件嗎?

不會。Hyperdocs 會產生草稿與建議,但你的團隊會先審閱、編輯、核准,然後才發布最終文件。

我可以把既有文件遷移到 Hyperdocs 嗎?

可以。價格頁面指出,現有文件可匯入 Hyperdocs,因此團隊不需要從零重建文件。

Hyperdocs 只適用於內部文件嗎?

Hyperdocs 主要是為面向外部的 SaaS 文件而打造,包括產品文件、說明中心、API 文件與更新紀錄。

Quick Facts

類別
AI 文件平台
主要使用者
SaaS 團隊
核心流程
從程式碼產生文件、與 GitHub 同步、審閱草稿,然後發布
文件類型
產品文件、說明中心、API 文件、更新紀錄
價格形式
免費方案加付費方案;商務與企業方案可洽詢
官方網站
hyperdocs.io