概念
GitBook の基本を学び、ユーザー向けに優れたドキュメントを作成・公開できるようにする
コンテンツの整理
スペース
スペースは、関連するページのコレクションをまとめて作業できるプロジェクトです。スペース内では、コンテンツの作成、グループやサブページを使ったページの整理、連携機能のインストールなどができます。
スペースを公開したい場合は、ドキュメントサイトに追加することで公開できます。ドキュメントサイトには、好きなだけ多くのスペースを追加できます。そのため、コンテンツを構築するときに、製品ドキュメント、APIリファレンス、変更履歴、ヘルプセンター、その他ドキュメントに含めたいものごとに個別のスペースを作成し、それらをすべて1つのドキュメントサイトで公開できます。
主なドキュメントの翻訳版を作成したり、製品の異なるバージョンごとに別のドキュメントを用意したりすることもできます。これらそれぞれにも専用のスペースがあり、1つのドキュメントサイトに追加してユーザーが閲覧できます。
コレクション
コレクションはGitBookアプリ内でフォルダのように機能し、スペースをまとめて整理しやすく、コンテンツを管理・保管しやすくします。
コンテンツを整理しやすくするだけでなく、コレクションは大規模なコンテンツレベルの権限管理も簡単にします。複数のスペースをコレクションに追加し、コレクション全体に対して権限を設定することで、組織レベルの権限を上書きできます。
ドキュメントサイト
コンテンツをドキュメントサイトとして公開できます。ドキュメントは公開され、選択した対象ユーザーが閲覧できるWebサイトとして公開されます。自分のブランディング、分析、カスタムドメインでカスタマイズできます。
ドキュメントサイトは好きなだけ作成できます。すべてサイドバーとアプリの「ドキュメントサイト」セクションに一覧表示され、そこで設定やカスタマイズのオプションを変更できます。GitBookアプリでドキュメントサイトのすべての設定とオプションを管理できます。
サイト上のコンテンツは、GitBook組織内のスペースから取得されます。新しいドキュメントサイトを作成すると、新しいスペースを作成するか、既存のスペースをリンクできます。ドキュメントサイトには1つのスペース、または翻訳や以前の製品バージョンを含む複数のスペースを含めることができます。
コンテンツの編集
GitBookのビジュアルエディタでは、WYSIWYG（見たままをそのまま取得する）インターフェースを使ってスペースにコンテンツを追加できます。
ページ
ページは、コンテンツを追加・編集・埋め込みする場所です。ページは常にスペース内にあり、スペースには好きなだけページを追加できます。
スペース内のページは、エディタ左側の目次に表示されます。ここで新しいページの追加、ページグループの作成、ページを他のページの中に入れてサブページを作成することができます。
ページの編集や追加方法が見つかりませんか？
サイトが公開されている場合、スペースのコンテンツに変更を加える前に変更リクエストを作成する必要があります。 変更リクエストについては以下を参照.
ブロック
GitBookはブロックベースのエディタです。つまり、標準的なテキストや画像から、より高度でインタラクティブなブロックまで、さまざまな種類のブロックをページに追加できます。ページには任意の組み合わせのブロックを含めることができ、1ページに配置できるブロック数に制限はありません。
ブロックベースの編集では、ドラッグ＆ドロップでコンテンツを簡単に再構成したり、既存コンテンツの途中に新しいブロックを追加したりできます。エディタ画面から新しいブロックを作成することも、Markdownを使ってブロックを作成・整形することもできます。
GitBookで使えるすべてのブロックを確認する ブロックセクションで.
Markdown編集
GitBookのエディタでは、Markdownを使ってコンテンツブロックを作成し、整形できます。
Markdownは、そのシンプルさで広く知られている人気のマークアップ構文です。GitBookは、リッチで構造化されたテキストをキーボード中心で記述できる方法としてこれをサポートしています。GitBookのすべてのブロックはMarkdown構文で書くことができます。
Markdown自体については、以下を訪問して詳しく学べます CommonMark.
Git Sync
Git Syncを使うと、チームはGitHubまたはGitLabのリポジトリをGitBookと同期し、Markdownファイルを見やすく使いやすいドキュメントに変換できます。設定後は、GitBookアプリとコードベースの間で、すべてのコンテンツを同期し続けます。
Git Syncは双方向なので、GitBookのビジュアルエディタで行った変更は自動的に同期され、GitHubやGitLabで行われたコミットも同期されます。これにより、開発者はGitHubやGitLabから直接コミットし、他のチームメンバーはGitBook上で変更を直接編集したりフィードバックを残したりできます。
Git Syncは、バッチ変更、リンティングなど、GitBookドキュメントで役立つ多くのワークフローも可能にします。詳しくは Git Syncセクションをご覧ください.
編集フロー
変更リクエスト
変更リクエストは ブランチ であり、メインコンテンツの履歴を維持しながら同時編集に使えます。GitHubのプルリクエストやGitLabのマージリクエストを使う人にはおなじみの仕組みです。
公開済みのドキュメントサイトの内容を編集したい場合は、まずスペースで変更リクエストを開く必要があります。
変更リクエストでは、スペース内のコンテンツを追加・編集・削除し、その後チームにレビューを依頼して、変更をメインコンテンツにマージし、公開済みのドキュメントサイトを更新できます。
ブランチの概要
変更リクエストを開くと、その特定時点のコンテンツのコピーが作成され、これを「ブランチ」と呼ぶことがあります。変更リクエストをマージするまでは、加えた変更はメインコンテンツには表示されません。
ブランチの利点は、チームメイトが互いに干渉することなく、あなたと同時にそれぞれの変更リクエストを作成・編集・マージできることです。もし誰かがあなたと同じコンテンツを編集した場合でも、GitBookがマージ前に競合解決を案内します。
レビュー
レビューは確認作業を促し、ドキュメントの品質と正確性の向上に役立ちます。
マージして変更をドキュメントサイトに反映する前に、変更リクエストに対してレビューを依頼できます。変更リクエストにタイトルと説明を追加すると、レビュー担当者に文脈を伝えられます。
レビュー担当者は変更リクエストの差分を確認でき、新しく追加・変更・削除された内容がすべてハイライト表示されます。組み込みのコメント機能を使ってページ上で直接フィードバックを残すこともでき、その後、変更リクエストを承認するか、さらに変更を求めることができます。
マージ
変更リクエストをマージすると、その変更リクエスト内のすべてのコンテンツがメインのコンテンツブランチに追加され、変更はドキュメントサイトにも公開されます。
変更リクエストをマージすると、スペースのバージョン履歴に新しいバージョンも作成されます。
ドキュメントの公開
コンテンツを ドキュメントサイトとして公開すると、サイトにさらにコンテンツを追加したり、対象ユーザーを変更したり、見た目やその他の設定をカスタマイズしたりできます。
ドキュメントサイトの構成
サイトに追加コンテンツを入れたい場合、用途の異なる2つの方法があります。サイトセクションとバリアントです。
サイトセクション
サイトセクションは、 1つのドキュメントサイトに複数種類のドキュメントを追加できるようにするためのものです。たとえば、このドキュメントサイトのように、1つのドキュメントサイトで製品ドキュメント、APIリファレンス、ヘルプセンター、変更履歴を公開することができます。
新しいサイトセクションを追加すると、サイト上部のナビゲーションバーが構築され、各セクションがバー上に独自の項目として表示されます。サイトセクションをまとめてグループ化し、ナビゲーションバーにドロップダウンメニューを作成することもできます。これはサイトセクションに階層を持たせるのに最適です。
バリアント
バリアントは、 同じドキュメントの複数バージョンを1つのドキュメントサイトに追加できるようにするためのものです。たとえば、ドキュメント全体を複数の言語にローカライズしたり、まだ更新していないユーザー向けに製品の以前のバージョンをドキュメント化したりできます。
エンドユーザーは、サイト左側の目次上部にある言語ピッカーまたはバリアントピッカーを使って、これらのバリアントを切り替えられます。
サイトの対象ユーザー
公開時に、誰がドキュメントを閲覧できるかを選択できます。新しいサイトのデフォルトは公開であり、検索エンジンによってインデックスされます。
ただし、サイトへのアクセス権をより細かく管理したい場合は、以下を使って閲覧対象を制限できます 共有リンク または 認証済みアクセス.
共有リンクを使えば、組織に招待せずに、プライベートリンクを作成して直接相手に共有することで、顧客やパートナーと非公開でコンテンツを共有できます。リンクを持っている人なら誰でもサイトにアクセスできます。
さらに制御したい場合は、認証済みアクセスにより、コンテンツを公開しつつ、閲覧したい訪問者に認証を要求できます。有効にすると、GitBookは認証プロバイダーにアクセス制御を任せます。これは、非公開コンテンツや、チームメンバーのみがアクセスできる社内ナレッジベースの公開に最適です。
適応型コンテンツと呼ばれる機能を使って、個々のページやブロックの表示対象も管理できます。設定すると、あなたが定めたユーザー属性に基づいてコンテンツを表示または非表示にします。詳しくは 適応型コンテンツのページをご覧ください.
サイトのカスタマイズ
GitBookにはドキュメントサイト向けの組み込みカスタマイズオプションがあり、ドキュメントの見た目や雰囲気を製品やブランドに合わせやすくなっています。
カスタマイズを何も適用しなくても、ドキュメントはそのままで十分に美しく表示されます。ただし、ロゴ、アイコン、色をカスタマイズしたり、カスタムフォントを追加したり、組み込みテーマから選んでドキュメントを製品に負けない見た目にしたりできます。
SEOとAI最適化
GitBookで公開されたドキュメントは、検索（SEO）と、ChatGPT、Claude、Google AI Overview（GEO）などのAIシステム向けに自動で最適化されます。これらはバックエンドで処理されるため、必要なのは対象としたいキーワードや用語を含むコンテンツを書くことだけです。
ページは各ページのタイトルと説明からメタデータを取得し、コンテンツはレスポンシブに整形されます。GitBookは目次に基づいてサイトマップを自動生成し、ページはキャッシュされ、グローバルCDN経由で配信されるためパフォーマンスが向上します。これらすべてが、ドキュメントの検索順位向上に役立ちます。
同様に、GitBookは進化の速い業界標準に従って、AIツール向けの最適化も行います。
GitBookは各ページの.md版を自動生成するため、大規模言語モデル（LLM）が解析しやすくなります。また、公開されたすべてのサイトに対してModel Context Protocol（MCP）サーバーを自動公開し、AIツールがドキュメントをリソースとして構造化された方法で見つけて取得できるようにします。スクレイピングは不要です。さらに、サイトは llms.txt 、 llms-full.txt AI取り込み向けに設計されています。
チーム管理
組織
GitBook組織には、1つの企業に属するすべてのコンテンツとドキュメントサイトが含まれます。1つのアカウントで1つまたは複数の組織に参加でき、GitBookアプリの左上にあるドロップダウンメニューから切り替えられます。
メンバー
メンバーは組織内の個々のユーザーです。組織には好きなだけ多くのメンバーを持つことができ、それぞれに特定のアクセス要件に合った権限を設定できます。
権限
権限を使うと、組織メンバーのアクセスレベルを決められます。メンバーが組織に参加すると、EditorやViewerなどの役割を割り当てます。これらの役割が、組織内のすべてのコンテンツに対する権限を定義します。ただし、コンテンツレベルでこれらの権限を上書きすることもできます。たとえば：
Viewerロールの人に、特定のコンテンツ1件だけ編集権限を与えられます
特定の機密または非公開コンテンツへのアクセスを制限し、組織内の一部メンバーにのみアクセスを許可できます。
詳しくは 権限と継承のページをご覧ください.
最終更新
役に立ちましたか？