Giraffe Doc icon

Giraffe Doc

Giraffe Docは、APIや技術ドキュメントをブランドサイトで公開できるホワイトラベル対応のドキュメントプラットフォームです。OpenAPI同期、ページ別アクセス制御、手動セットアップの早期導入に対応。

Giraffe Doc

Giraffe Doc とは

Giraffe Doc は、ブランドサイトで API および技術ドキュメントを公開する必要がある企業向けのドキュメント公開製品です。サイトの説明では、OpenAPI、Git 同期、ページ別アクセス制御に対応したホワイトラベルのドキュメントサイトをサポートするとされています。

収集されたページを見ると、この製品は、チームが docs サイトを作成し、ポータルでガイドを執筆し、API リファレンス資料を同期し、サブドメインまたはカスタムドメインで公開するワークフローを中心にしています。早期アクセスには手動セットアップサービスも含まれており、チームが最初のサイトを手作業で構築して公開し、月額サブスクリプションとして提供します。

主な機能

ポータルベースの編集

ポータル内でドキュメントを作成・編集でき、公開前に生の MDX を切り替えたり、ライブの docs chrome でページをプレビューしたりできます。

OpenAPI 同期

OpenAPI スペックをアップロードするか、ライブのスペック URL と同期して、API リファレンスをドキュメントと整合させます。

ホワイトラベルのドキュメントサイト

会社のサブドメインまたはカスタムドメインに、ブランドに合ったレイアウトのドキュメントサイトを公開できます。

ページ別アクセス制御

ページを公開、非公開、またはトークンゲート付きに設定でき、ページ単位またはセクション単位で可視性を適用できます。

手厚いオンボーディング

OpenAPI スペック、Postman コレクション、既存のドキュメントなどの既存ソースから開始し、早期アクセス期間中にサイトを手作業で構築してもらえます。

一般的なユースケース

  • 統合された docs サイトを公開する

    チームは API リファレンスと説明ガイドを並べて公開できるため、開発者やパートナーが別々のシステムではなく 1 つの docs の公開先を利用できます。

  • API リファレンスを同期する

    すでに OpenAPI スペックを管理している企業は、それを docs サイトに同期して、リファレンスを元の定義と一致させたまま保てます。

  • ページまたはセクションごとにアクセスを制御する

    アクセスを選別する必要がある組織は、一般読者向けに公開ページを出し、他のセクションは非公開またはトークンゲート付きにできます。

  • ホワイトラベルの docs ポータルを公開する

    ブランド化された外部向けドキュメントを求めるチームは、会社のサブドメインまたはカスタムドメインに、見た目を揃えたレイアウトで公開できます。

  • 既存ドキュメントを製品へ移行する

    早期アクセスのユーザーは、OpenAPI スペック、Postman コレクション、または既存のドキュメントを送ることで、最初のサイトを手作業でセットアップしてもらえます。

Pros and Cons

Pros

  • サブドメインまたはカスタムドメイン上で、ブランド付きのドキュメントサイトをサポートします。
  • ガイド作成、API リファレンス同期、公開を 1 つのワークフローにまとめています。
  • サイト全体の一括アクセス設定ではなく、ページ単位の表示制御を提供します。
  • OpenAPI、Postman コレクション、既存ドキュメントなど、複数の開始点を受け付けます。
  • 早期アクセスのセットアップはチームが対応するため、管理された立ち上げを望む企業に役立つ可能性があります。

Cons

  • 収集された証拠にある公開価格ページは 404 を返したため、早期アクセスの提供内容を超えるプラン詳細はここでは確認できません。
  • ソースでは Git 同期と認証の正確な仕組みに関する詳細が限られているため、技術統合の深さはこの証拠だけでは不明です。
  • 早期アクセスではチームによる手動セットアップが必要なようで、セルフサービス型のオンボーディングより時間がかかる可能性があります。

FAQ

セットアップはどのように行われますか?

Giraffe Doc は早期アクセス期間中に手動でセットアップされます。オンボーディングの流れでは、会社情報、対象範囲、手元にあるファイルを共有するよう求められ、その後、サイトが構築され公開される前に月額 45 ドルのサブスクリプションが開始されます。

どのようなチーム向けですか?

ソース内容によると、この製品はガイドや API リファレンスを含む、API および技術ドキュメントを公開する企業向けです。OpenAPI 同期とページ別アクセス制御を備えたホワイトラベルのドキュメントサイトを求めるチーム向けに位置づけられています。

どのようなソースを取り込めますか?

ドキュメントサイトはサブドメインまたはカスタムドメインで作成でき、ポータル内で記述し、API がある場合は OpenAPI を接続できます。オンボーディングの流れでは、OpenAPI または Postman の JSON、YAML、zip ファイルも受け付けます。

アクセス制御はどのように扱われますか?

ソースでは、ページを公開、非公開、またはトークンゲート付きにでき、可視性はサイト全体ではなくセクションごとに設定できると記載されています。

どの価格情報が確認されていますか?

収集された証拠では価格ページ自体が 404 を返していたため、確認できる料金情報は、早期アクセスで示されている月額 45 ドルのサブスクリプションのみです。

Quick Facts

カテゴリ
開発者向けツール
製品タイプ
API および技術ドキュメントプラットフォーム
ブランド
Giraffe Doc
ソースドメイン
doc.giraffe.ge
確認済みの早期アクセス価格
$45/月
公開オプション
サブドメインまたはカスタムドメイン

Giraffe Docの代替品