概念

GitBookの基本を学び、ユーザー向けの優れたドキュメントを作成・公開できるようになりましょう

コンテンツの整理

スペース

スペースは、関連するページのコレクションに取り組めるようにするプロジェクトです。スペース内では、コンテンツを作成したり、グループやサブページでページを整理したり、連携機能をインストールしたりできます。

スペースを公開したい場合は、Docsサイトに追加することで公開できます。Docsサイトには好きなだけスペースを追加できます。そのため、コンテンツを作成していく際には、製品ドキュメント、APIリファレンス、変更履歴、ヘルプセンターなど、ドキュメントに含めたいものごとに個別のスペースを作成し、それらをすべて1つのDocsサイトに公開できます。

主要なドキュメントの翻訳版や、製品の異なるバージョンごとに別々のドキュメントを作成したい場合もあるでしょう。これらはそれぞれ独自のスペースを持ち、ユーザーが閲覧できるように単一のDocsサイトに追加できます。

コレクション

コレクションはGitBookアプリ内でフォルダのように機能し、スペースをまとめてグループ化できるため、コンテンツの整理と保存がしやすくなります。

コンテンツを整理しやすくするだけでなく、コレクションは大規模なコンテンツレベルの権限管理も容易にします。複数のスペースをコレクションに追加してコレクション全体の権限を設定することで、組織レベルの権限を上書きできます。

Docsサイト

コンテンツをDocsサイトとして公開できます。ドキュメントは公開され、独自のブランド、分析、カスタムドメインでカスタマイズできるWebサイトとして、選択した対象者に提供されます。

Docsサイトは好きなだけ作成できます。すべてサイドバーとアプリのDocsサイトセクションに一覧表示され、そこで設定やカスタマイズオプションを変更できます。Docsサイトのあらゆる設定やオプションはGitBookアプリで管理できます。

サイト上のコンテンツは、GitBook組織内のスペースから取得されます。新しいDocsサイトを作成するときに、新しいスペースを作成することも、既存のスペースをリンクすることもできます。Docsサイトには1つのスペース、または翻訳や以前の製品バージョンを含む複数のスペースを含めることができます。

コンテンツの編集

GitBookのビジュアルエディタを使うと、WYSIWYG（見たままをそのまま得られる）インターフェースでスペースにコンテンツを追加できます。

ページ

ページは、コンテンツを追加・編集・埋め込みする場所です。ページは常にスペース内にあり、スペースには好きなだけページを追加できます。

スペース内のページは、エディタ左側の目次に表示されます。ここで新しいページを追加したり、ページグループを作成したり、ページ内にページを入れ子にしてサブページを作成したりできます。

ページの編集や追加方法が見つかりませんか？

サイトが公開されている場合、スペースのコンテンツに変更を加える前に、変更リクエストを作成する必要があります。 変更リクエストについては以下をご覧ください.

ブロック

GitBookはブロックベースのエディタです。つまり、標準的なテキストや画像から、より高度でインタラクティブなブロックまで、さまざまな種類のブロックをページに追加できます。ページには好きなブロックの組み合わせを含めることができ、1ページに配置できるブロック数に制限はありません。

ブロックベースの編集では、ドラッグ＆ドロップでコンテンツを簡単に再配置したり、既存コンテンツの途中に新しいブロックを追加したりできます。エディタのインターフェースで新しいブロックを作成することも、Markdownを使ってブロックを作成・整形することもできます。

GitBookで使えるすべてのブロックを見つける ブロックセクションで.

Markdown編集

GitBookのエディタでは、Markdownを使ってコンテンツブロックを作成・整形できます。

Markdownは、そのシンプルさで広く知られている人気のマークアップ構文です。GitBookは、リッチで構造化されたテキストをキーボード中心で書ける方法としてMarkdownをサポートしており、GitBookのすべてのブロックをMarkdown構文で記述できます。

Markdownそのものについて詳しく知りたい場合は、 CommonMark.

Git 同期

Git Syncを使うと、チームはGitHubまたはGitLabリポジトリをGitBookと同期し、Markdownファイルを美しく使いやすいドキュメントに変換できます。設定後は、GitBookアプリとコードベースの間で、すべてのコンテンツを同期し続けます。

Git Syncは双方向なので、GitBookのビジュアルエディタで行った変更も自動的に同期され、GitHubやGitLabで行われたコミットも同期されます。これにより、開発者はGitHubやGitLabから直接コミットでき、他のチームメンバーはGitBook上で変更を編集したり、直接フィードバックを残したりできます。

Git Syncは、GitBookドキュメントで一括変更やリンティングなど、ほかにも多くの便利なワークフローを実現します。詳しくは Git Syncセクションをご覧ください.

編集フロー

変更リクエスト

変更リクエストは ブランチ であり、バージョン履歴を維持しながら同時編集を行うために使えます。GitHubのプルリクエストやGitLabのマージリクエストを使う人なら、なじみやすいでしょう。

公開済みのDocsサイトのコンテンツを編集したい場合は、まずスペースで変更リクエストを開く必要があります。

変更リクエストでは、スペース内のコンテンツを追加・編集・削除したうえで、チームにレビューを依頼し、変更をメインコンテンツにマージして公開済みのDocsサイトを更新できます。

ブランチ作成の概要

変更リクエストを開くと、その特定の時点でのコンテンツのコピーが作成されます。これは「ブランチ」と呼ばれることもあります。変更リクエストをマージするまでは、加えた変更はメインコンテンツには表示されません。

ブランチ作成の利点は、チームメイトがあなたと同時に自分の変更リクエストを作成・編集・マージしても、お互いに干渉しないことです。もし誰かがあなたと同じコンテンツを編集した場合でも、GitBookがマージ前に競合の解決を案内します。

レビュー

レビューは、確認を促し、ドキュメントの品質と正確性の向上に役立ちます。

変更をマージしてDocsサイトで公開される前に、変更リクエストに対してレビューを依頼できます。変更リクエストにタイトルと説明を追加すると、レビュアーに文脈を伝えられます。

レビュアーは変更リクエストの差分を確認でき、変更リクエスト内で新規・変更・削除された内容がすべて強調表示されます。組み込みのコメント機能を使ってページ上で直接フィードバックを残すこともでき、その後、変更リクエストを承認するか、さらなる変更を求めることができます。

マージ

変更リクエストをマージすると、その変更リクエスト内のすべてのコンテンツがメインブランチのコンテンツに追加され、その変更はDocsサイトにも公開されます。

変更リクエストをマージすると、スペースのバージョン履歴にも新しいバージョンが作成されます。

ドキュメントの公開

コンテンツを Docsサイトとして公開すると、サイトにさらにコンテンツを追加したり、対象読者を変更したり、見た目やその他の設定をカスタマイズしたりできます。

Docsサイトの構成

サイトに追加コンテンツを入れたい場合は、用途の異なる2つの選択肢があります。サイトセクションとバリアントです。

サイトセクション

サイトセクションは、 さまざまな種類のドキュメントを1つのDocsサイトに複数追加できるように設計されています。たとえば、このDocsサイトのように、1つのDocsサイトで製品ドキュメント、APIリファレンス、ヘルプセンター、変更履歴を公開できます。

新しいサイトセクションを追加すると、サイト上部のナビゲーションバーが構築され、各セクションがバー上の個別の項目として表示されます。また、サイトセクションをグループ化して、ナビゲーションバーにドロップダウンメニューを作成することもできます。これは、サイトセクションに階層を持たせたい場合に最適です。

バリアント

バリアントは、 同じドキュメントの複数バージョンを1つのDocsサイトに追加できるように設計されています。たとえば、ドキュメント全体を複数の言語にローカライズしたり、未更新のユーザー向けに製品の以前のバージョンを記載したりできます。

エンドユーザーは、サイト左側の目次上部にある言語ピッカーまたはバリアントピッカーを使って、これらのバリアントをDocsサイト上で切り替えられます。

サイトセクションはサイト上部にナビゲーションバーを作成し、ユーザーは目次内のメニューでバリアントを切り替えられます。

サイトの対象読者

公開時に、誰がドキュメントを見るかを選択できます。新しいサイトのデフォルトでは公開され、検索エンジンにインデックスされます。

ただし、サイトにアクセスできる人をより細かく制御したい場合は、次を使って対象読者を制限できます 共有リンク または 認証済みアクセス.

共有リンクを使うと、プライベートリンクを作成して直接共有するだけで、組織に招待することなく顧客やパートナーとコンテンツを非公開で共有できます。リンクを持っている人なら誰でもサイトにアクセスできます。

さらに制御したい場合は、認証済みアクセスを使うことで、コンテンツを公開しつつ、閲覧したい訪問者に認証を求めることができます。有効にすると、GitBookはアクセス権の管理を認証プロバイダーに委ねます。これは、プライベートコンテンツや、チームメンバーだけがアクセスできる社内ナレッジベースを公開する場合に最適です。

アダプティブコンテンツという機能を使えば、個々のページやブロックを誰に見せるかも制御できます。設定後は、あなたが定義したユーザー属性に基づいてコンテンツの表示・非表示を切り替えます。詳しくは アダプティブコンテンツのページをご覧ください.

サイトのカスタマイズ

GitBookにはDocsサイト向けの組み込みカスタマイズオプションがあり、ドキュメントの見た目や雰囲気を製品やブランドに合わせやすくなっています。

カスタマイズを一切適用しなくても、ドキュメントはそのままで十分美しく表示されます。ただし、ロゴ、アイコン、色をカスタマイズしたり、カスタムフォントを追加したり、Docsを製品に負けないくらい魅力的に見せる組み込みテーマを選んだりすることもできます。

独自のロゴ、色、フォント、画像などを使って、ブランドに合うようにドキュメントをカスタマイズできます。

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の組織には、個々の会社に属するすべてのコンテンツとDocsサイトが含まれます。1つのアカウントで1つまたは複数の組織のメンバーになれ、GitBookアプリ左上のドロップダウンメニューで切り替えられます。

メンバー

メンバーは、組織内の個々のユーザーです。組織には好きなだけメンバーを追加でき、それぞれに必要なアクセス権に応じた権限を設定できます。

権限

権限では、組織メンバーのアクセスレベルを決められます。メンバーが組織に参加すると、EditorやViewerなどの役割を割り当てます。これらの役割が、組織内のすべてのコンテンツに対する権限を定義します。ただし、コンテンツレベルでこれらの権限を上書きすることもできます。たとえば、

• Viewerロールの人に、特定のコンテンツ1件の編集アクセスを付与できます

• 特定の機密コンテンツや非公開コンテンツへのアクセスを制限し、組織の特定メンバーのみにアクセスを許可できます。

詳しくは 権限と継承のページをご覧ください.