Hyperdocs icon

Hyperdocs

Hyperdocsは、SaaSチーム向けのAIドキュメントプラットフォーム。コードベースから製品ドキュメントを生成・更新し、GitHubと同期。公開ドキュメント、ヘルプセンター、APIドキュメント、変更履歴に対応。

Hyperdocs

概要

Hyperdocsは、SaaSチーム向けのAIドキュメントプラットフォームで、コードベースから公開向けの製品ドキュメントを作成・維持します。製品ドキュメント、ヘルプセンター、APIドキュメント、変更履歴向けに位置づけられており、コード変更を人間のレビュー用の下書きドキュメント更新に変換するワークフローを備えています。

この製品はGitHubと連携し、リポジトリの変更をスキャンして、どのページに対応が必要かを提案します。既存のコードベースからドキュメントの下書きを生成することもでき、チームが公開前に変更をレビュー、編集、承認できるように設計されています。

機能

GitHub同期と変更検出

GitHubリポジトリを接続すると、Hyperdocsがコード変更を検出し、更新が必要になりそうなドキュメントを特定して、レビュー用の改訂案を作成できます。

コードからドキュメントへの生成

製品ドキュメント、セットアップガイド、APIリファレンス、ヘルプ記事を含む、コードベースから編集可能な下書きを生成できます。

複数のドキュメントモジュール

製品ドキュメント、ヘルプセンター、APIドキュメント、変更履歴を、個別のツールを管理する代わりに1つのワークスペースから公開できます。

公開ドキュメントの公開とブランディング

検索可能な公開ドキュメントに、SEO対応の構造、メタデータ、高速なページ、カスタムドメインやブランド化されたナビゲーションのサポートを加えられます。

検索、分析、フィードバック

ユーザーが何を検索し、読んで、見逃し、見つけにくいと感じているかを確認し、フィードバックを集めてドキュメントの不足を可視化できます。

AI支援のドキュメントワークフロー

付属のAI Answer AgentとDocs Agentを使って、質問への回答やドキュメント内容の作成・更新を支援できます。

ユースケース

  • コードベースからドキュメントを作成する

    フロントエンドまたは製品リポジトリを接続して、ゼロから始めるときに製品ドキュメント、セットアップ手順、機能説明の編集可能な下書きページを作成します。

  • 製品変更の公開に合わせてドキュメントを保守する

    GitHubの変更を確認し、影響を受ける可能性のあるページを把握し、承認後に更新を公開することで、製品リリースに合わせてドキュメントを維持します。

  • ヘルプセンターを構築する

    サポートチケットを開かずに回答を得たいユーザー向けに、検索可能なセルフサービス記事を公開し、ヘルプセンター形式とフィードバックツールで不足を把握します。

  • APIドキュメントを公開する

    製品ドキュメントや変更履歴と同じワークスペース内で、リファレンス、ガイド、例を使ってAPIを文書化します。

  • 既存のドキュメントサイトを移行する

    既存のドキュメントをHyperdocsにインポートし、構造を保ったまま、手作業で移行する代わりにプラットフォーム内で編集と公開を継続します。

Pros and Cons

Pros

  • コードからドキュメントの下書きを生成できるため、新規作成や更新時の手作業による初稿作成を減らせる可能性があります。
  • GitHubと同期するため、ドキュメントを製品変更により密接に追従させられます。
  • 製品ドキュメント、ヘルプセンターの内容、APIドキュメント、変更履歴を含む複数の公開ドキュメント形式を1つのプラットフォームでサポートしています。
  • AIの出力を自動公開せず、公開前レビューの制御を備えています。
  • 分析、フィードバック、検索データにより、チームがドキュメントの不足を特定しやすくなります。

Cons

  • 料金ページでは使用制限とプランごとの機能差が示されているため、一部の機能へのアクセスは選択したワークスペースプランに依存します。
  • 承認ワークフロー、高度な連携、一部のエージェント機能など、ビジネスおよびエンタープライズ向けのワークフローは、一般提供ではなく近日公開、早期アクセス、またはカスタムとして掲載されています。

FAQ

Hyperdocsとは何ですか?

Hyperdocsは、SaaSチーム向けのAIネイティブなドキュメントプラットフォームです。製品ドキュメント、ヘルプセンター、APIドキュメント、変更履歴の生成、公開、保守を行うよう設計されています。

HyperdocsはGitHubからドキュメントを生成できますか?

はい。HyperdocsはGitHubリポジトリに接続し、コード構造と変更内容を理解して、そのソースから編集可能なドキュメントの下書きを作成できます。

HyperdocsはAI生成ドキュメントを自動公開しますか?

いいえ。Hyperdocsは下書きと提案を生成しますが、最終的なドキュメントはチームがレビューし、編集し、承認してから公開します。

既存のドキュメントをHyperdocsに移行できますか?

はい。料金ページによると、既存のドキュメントはHyperdocsにインポートできるため、チームはドキュメントを一から作り直す必要はありません。

Hyperdocsは社内向けドキュメント専用ですか?

Hyperdocsは主に、製品ドキュメント、ヘルプセンター、APIドキュメント、変更履歴を含む、公開向けのSaaSドキュメント用に作られています。

Quick Facts

カテゴリ
AIドキュメントプラットフォーム
主な利用者
SaaSチーム
コアワークフロー
コードからドキュメントを生成し、GitHubと同期し、下書きをレビューしてから公開
ドキュメントの種類
製品ドキュメント、ヘルプセンター、APIドキュメント、変更履歴
料金形態
無料プランと有料プランがあり、ビジネスおよびエンタープライズ向けオプションは問い合わせで利用可能
公式サイト
hyperdocs.io

Hyperdocsの代替品

ByteAsk icon

ByteAsk

ByteAskは、C/C++向けのターミナル起点AIコーディングエージェント。リポジトリを編集し、コンパイラやデバッガ、サニタイザ、テストで変更を検証してから差分を表示。無料枠あり。

hob icon

hob

hobは、エージェントのセッション、ターミナル、履歴、後続作業を、既存のツールやプロバイダーに合わせて整理できる独立したコーディングエージェント向けワークスペース。ローカルでの制御を重視する開発者に最適。

Ably Chat icon

Ably Chat

Ably Chatは、カスタムのリアルタイムチャットアプリを構築できるチャットAPIプラットフォームです。ルーム単位のメッセージ、入力中表示、プレゼンス、リアクション、メッセージ更新に対応し、利用量ベースの料金も選べます。

Manta AI icon

Manta AI

Manta AIは、URLからアプリの挙動を把握し、回帰を検出し、スクリプトやセレクタ管理なしでテストを生成できる自律型Webアプリテストツールです。

Falconer icon

Falconer

Falconerは、GitHub、Slack、Linearなどと同期し、社内ドキュメントを正確に保ち、検索しやすく最新化するAI搭載の会社の頭脳。エンジニアや横断チームのナレッジを集約し、共通の情報源から質問に答えます。

SonOf icon

SonOf

SonOfは、リポジトリとPMツールに接続し、コードベースと周辺の製品コンテキストを監査して、承認済みの作業をシニアエンジニアのレビュー付きで公開済みチケットに変えます。