Docsbookの概念: ワークスペース、プロジェクト残高、インデックス作成
Docsbookのインターフェースとドキュメントで使用されるすべての用語を、一度だけ定義します。各項目では、まず1文で定義し、その用語に出会う場所と、用語が影響するものを説明します。用語はグループ化され、各グループ内ではアルファベット順に並べられています。
サイトとそのコンテンツ#
ワークスペース#
ワークスペースとは、Markdownファイルのリポジトリを基盤とする、1つのドキュメントサイトとその設定のことです。リポジトリは、GitHub上にある自分のものか、ウェブサイトのスキャンまたは作成した概要から開始した際にDocsbookがホスティングするもののいずれかです。
ワークスペースには、アドレス、外観、言語設定、アナリティクス、残高が紐づいています。Docsbookの管理パネルと請求画面では、同じオブジェクトをプロジェクトと呼びます。この2つの言葉は同じものを意味します。
下書き#
下書きとは、まだ公開されていない生成済みのドキュメントサイトです。Docsbookは、アカウントを作成する前にソースから下書きを作成します。
ウェブサイトのスキャンや作成したブリーフから作成した下書きは、公開するまでブラウザ内に保存されます。下書きは、公開済みのワークスペースと同じ管理パネルで開くため、サインインする前にブランディング、レイアウト、SEOを設定できます。
ページ#
ページは、ワークスペースリポジトリ内の1つのMarkdownファイルであり、それぞれ固有のURLで提供されます。ファイル名とフォルダー名によって、URLとナビゲーションツリー内の位置が決まります。
.md と .markdown の拡張子は読み込まれます。その他の形式（.txt、.rst）のファイルはページに変換されません。
ナビゲーションツリー#
ナビゲーションツリーは、リポジトリのフォルダー構造からDocsbookが構築するサイドバーです。フォルダーはグループになり、ファイルはその下のエントリになります。
フォルダーのルートにあるREADME.mdが、そのフォルダーのランディングページになります。ナビゲーションファイルを記述する必要はありません。リポジトリ内でファイルを移動すると、サイドバー内でも移動します。
アウトライン#
アウトラインは、Docsbookがそのページの見出しから作成するページごとの目次で、コンテンツの右側に表示されます。見出しをクリックすると、ページがその位置までスクロールします。
アウトラインはH2以下の見出しから生成されるため、見出しレベルを飛ばすと、アウトラインに空きが生じます。
コンテンツウィジェット#
コンテンツウィジェットとは、Docsbookがリッチブロック（カードグリッド、アコーディオン、番号付き手順、または行動喚起）としてレンダリングするMarkdownページの領域で、2つのHTMLコメントで示されます。
コメントは他のすべてのMarkdownリーダーでは非表示になるため、同じファイルをGitHub上でも正しく読むことができます。不明なウィジェット名は通常のMarkdownとして処理され、非表示になるものはありません。コンテンツウィジェットを参照してください。
コンテンツの取り込みと最新状態の維持#
インデックス作成#
インデックス作成とは、サイトに必要なすべてのもの（検索インデックス、ナビゲーションツリー、ページごとのアウトライン、リンクグラフ、AIチャットが検索する埋め込み）を構築するために、DocsbookがMarkdownに対して実行する処理です。
インデックス作成は、ワークスペースの作成時と、Docsbookが変更されたコンテンツを検出したときに実行されます。インデックスが作成されていないページは、検索で見つけたり、チャットで引用したりできません。
GitHub同期#
GitHub同期とは、Docsbookサイトをリポジトリと同期した状態に保つ仕組みです。サイトにアクセスすると、DocsbookはGitHubで新しいコミットを確認し、変更された内容を再インデックスします。設定が必要なWebhookも、待機するビルド手順もありません。
同期されるもの：新しい.mdファイル、テキストの編集、削除、名前の変更、新しいフォルダー。同期されないもの：コミット履歴、ブランチ情報、コードコメント、その他の形式のファイル。
信頼できる情報源#
信頼できる情報源とは、ワークスペースに接続したリポジトリまたはウェブサイトのことで、ドキュメントを作成するエージェントが記憶から情報を引き出すのではなく、そこから事実を読み取れるようにするものです。接続された各ソースには、接続した理由について所有者自身が記したメモが付属します。
ソースは読み取り専用の入力です。サイトの構築元となるリポジトリとは別のものです。接続済みソースを参照してください。
Webエディター#
Webエディターは、ワークスペースのMarkdownファイル用のDocsbookのブラウザー内エディターです。保存すると、サイトのビルド元となるリポジトリにコミットされます。
Webエディター、GitHub、MCP経由のエージェントで行った編集はすべて同じリポジトリに反映されるため、履歴が2つに分かれることはありません。
料金とメータリング#
プロジェクト残高#
プロジェクト残高とは、1つのワークスペースに紐づけられ、そのワークスペースで行われるAI作業に使用される資金です。新しいプロジェクトはすべて$1.00の残高で作成され、さらにプロジェクト作成から3分経過後に所有者が請求できる$5.00が加算されます。その後は請求画面から残高を追加できます。
残高はアカウント単位ではなくプロジェクト単位です。1つのプロジェクトの残高がなくなっても、別のプロジェクトは停止しません。料金をご覧ください。
チャージ#
チャージとは、指定した金額を1つのプロジェクトの残高に入金することです。1回あたりのチャージ額は20.00ドル以上、5,000.00ドル以下です。
チャージに有効期限はなく、残高が定期的に補充されることもありません。請求画面で毎月の定期支払いを設定できます。設定すると、毎月同じ残高にチャージされます。
従量制の作業#
従量制の作業とは、プロジェクトの残高を消費する作業です。種類はちょうど4つあり、それぞれプロジェクトの「制限」カードにあるソース別の支出の行に対応します。
- 閲覧者（AIチャット） — 公開されたドキュメントの閲覧者に提供されるAIの回答。
- 管理者とAIエージェント — 従量制のMCPツール呼び出しを含む、エージェントの実行。
- AI翻訳 — ページを別の言語に翻訳する作業。
- セマンティックインデックス — AIチャットが参照する埋め込みを構築する作業。
これ以外は従量制ではありません。ホスティング、カスタムドメインとそのTLS証明書、閲覧者、編集者、GitHub同期、全文検索、ブランディング、分析、MCPの読み取り呼び出しは、いずれも使用ごとの料金がかかりません。4つのソースはいずれも「制限」カードからサイクルごとに上限を設定でき、上限を$0にすると、そのソースは無効になります。
マークアップ#
マークアップとは、回答に使用したモデルに対してAIプロバイダーが設定する実際の料金にDocsbookが上乗せする割合で、現在は900%です。モデル、その100万トークンあたりの料金、マークアップはすべてダッシュボードに表示されます。
ご自身のプロバイダーAPIキーを使用すると、マークアップはなくなります。プロバイダーに直接支払い、その利用分についてDocsbookから請求されることはありません。
サイトを読める人#
公開サイト#
公開サイトはデフォルト設定です。リンクを知っている人なら誰でも閲覧でき、GitHubアカウントを持っていない人や検索エンジンのクローラーも含まれます。リポジトリ自体の公開設定はこれを変えません。Docsbookがリポジトリを読み取り、ビルドしたページを提供するためです。
公開設定により、サイトがGoogleにインデックス登録され、AIアシスタントによる引用が可能になります。
プライベートサイト#
プライベートサイトでは、共有パスワードまたは独自のSSO IDプロバイダーによってアクセスが制限され、所有者以外のユーザーにはコンテンツの代わりにロック解除画面が表示されます。読者がロックを解除するまで、構成、ページ、検索インデックスは非表示のままです。
表示設定にかかわらず、所有者は常に完全なアクセス権を持ちます。プライベートドキュメント：パスワードとSSOをご覧ください。
カスタムドメイン#
カスタムドメインとは、docs.yourcompany.com という独自のホスト名で、docsbook.io/{owner}/{repo} の代わりにワークスペースを提供するものです。CNAMEレコードを1つ追加すると、DocsbookがTLS証明書をプロビジョニングします。
カスタムドメインを設定した後も、docsbook.io アドレスは引き続き機能します。カスタムドメインの設定を参照してください。
機械が読み取るサーフェス#
llms.txt#
llms.txt は、サイトのルートで、llms.txt を探す AI エージェント向けに提供される Docsbook サイトのプレーンテキスト形式のインデックスです。各ページと、それぞれのページで扱っている内容が一覧表示されます。
Docsbook はインデックス化されたコンテンツからこれを生成するため、サイトとは別に古くなることはありません。llms.txt を参照してください。
MCP サーバー#
MCP サーバーは、https://docsbook.io/api/mcp/server にあるDocsbookのModel Context Protocolエンドポイントで、AIエージェントがドキュメントの読み取り、検索、設定の変更、ページのコミットを行える309個のツールを公開しています。認証には、PKCEを使用したOAuth 2.0のBearer認証を採用しています。
ディスカバリー呼び出しは使用量として計測されません。それ以外の呼び出しではプロジェクトの残高が消費されます。詳しくはMCP サーバーおよびMCPツールリファレンスをご覧ください。
フロートウィジェット#
フロートウィジェットは、自分が公開したドキュメントの右下隅にあるコントロールメニューで、サインイン中の自分にのみ表示されます。読者には表示されません。
チャット、リポジトリ、モードを切り替えたり、設定を開いたり、サインアウトしたりできます。
関連#
- 概要 — これらの要素が最初から最後までどのように組み合わさるか
- クイックスタート — これらの用語を順番に使用するチュートリアル
- MCPツールリファレンス — すべてのツール、そのパラメーター、料金クラス
- 料金 — 何が従量制で、プロジェクト残高が何に支払われるか