基本概念
GitBookの基本を学び、ユーザー向けの優れたドキュメントを作成・公開できるようにしましょう
コンテンツの整理
セクション
セクションは、関連するページのセットを扱えるようにするプロジェクトです。セクション内では、コンテンツを作成し、ページグループやサブページでページを整理し、連携機能をインストールするなど、さまざまなことができます。
セクションは docs site に属しており、docs site には好きなだけセクションを追加できます。そのため、コンテンツを作成していく際に、製品ドキュメント、API リファレンス、変更履歴、ヘルプセンター、その他ドキュメントに含めたいあらゆる内容ごとに別々のセクションを作成し、それらをすべて 1 つの docs site に公開できます。
メインのドキュメントの翻訳版を作成したり、製品のバージョンごとに別のドキュメントを作成したりすることもできます。それぞれに独自のセクションがあり、1 つの docs site に追加してユーザーに閲覧してもらえます。
グループ
グループは GitBook アプリ内のフォルダのように機能し、関連するセクションをまとめておけるため、コンテンツを整理して保存しやすくなります。
コンテンツを整理しやすくするだけでなく、グループを使うとコンテンツ単位の権限も大規模に管理しやすくなります。複数のセクションをグループに追加してグループ全体に権限を設定することで、組織レベルの権限を上書きできます。
docs site
コンテンツを docs site として公開できます。ドキュメントは、独自のブランディング、分析、カスタムドメインでカスタマイズできる Web サイトとして公開され、選択した対象ユーザーが利用できるようになります。
docs site は好きなだけ作成できます。これらはすべてサイドバーとアプリの Docs sites セクションに一覧表示され、そこで設定やカスタマイズのオプションを変更できます。GitBook アプリで、docs site のすべての設定とオプションを管理できます。
サイトのコンテンツは、そのセクション内にあります。新しい docs site を作成すると、新しいセクションを作成することも、既存のコンテンツを追加することもできます。docs site には、1 つのセクションだけを含めることも、翻訳版や以前の製品バージョンを含む複数のセクションを含めることもできます。
コンテンツの編集
GitBook のビジュアルエディタでは、WYSIWYG（見たままをそのまま編集）インターフェースを使ってセクションにコンテンツを追加できます。
編集はデスクトップおよびノート PC で利用できます。スマートフォンでは組織やコンテンツを閲覧できますが、編集にはデスクトップまたはノート PC が必要です。
ページ
ページは、コンテンツを追加、編集、埋め込みする場所です。ページは常にセクション内にあり、セクションには好きなだけページを追加できます。
セクション内のページは、エディタ左側の目次に表示されます。ここで、新しいページの追加、ページグループの作成、ページを他のページの下に入れ子にしてサブページを作成できます。
ページの編集や追加方法がわかりませんか？
サイトが公開されている場合、セクションのコンテンツに変更を加える前に、変更リクエストを作成する必要があります。 変更リクエストについては以下をお読みください.
ブロック
GitBook はブロックベースのエディタです。つまり、標準的なテキストや画像から、より高度でインタラクティブなブロックまで、さまざまな種類のブロックをページに追加できます。ページには好きな組み合わせのブロックを含めることができ、1 ページあたりのブロック数に制限はありません。
ブロックベースの編集では、ドラッグ＆ドロップでコンテンツを簡単に再配置したり、既存コンテンツの途中に新しいブロックを追加したりできます。エディタのインターフェースを使って新しいブロックを作成することも、Markdown を使ってブロックを作成・整形することもできます。
GitBook で使えるすべてのブロックを見つける ブロック セクションで.
Markdown 編集
GitBook のエディタでは、Markdown を使ってコンテンツブロックを作成し、整形できます。
Markdown は、シンプルさで広く知られている人気のマークアップ構文です。GitBook では、リッチで構造化されたテキストを書くためのキーボードフレンドリーな方法として Markdown をサポートしており、GitBook のすべてのブロックを Markdown 構文で記述できます。
Git Sync
Git Sync を使うと、チームは GitHub や GitLab のリポジトリを GitBook と同期させ、Markdown ファイルを美しく使いやすいドキュメントに変換できます。設定後は、GitBook アプリとコードベース間のすべてのコンテンツを同期し続けます。
Git Sync は双方向なので、GitBook のビジュアルエディタで行った変更は自動的に同期されます。GitHub や GitLab で行われたコミットも同様です。これにより、開発者は GitHub や GitLab から直接コミットでき、ほかのチームメンバーは GitBook 上で変更を編集し、フィードバックを残せます。
Git Sync は、バッチ変更や lint など、GitBook のドキュメントで役立つほかの多くのワークフローも可能にします。詳しくは Git Sync セクションをご覧ください.
編集フロー
変更リクエスト
変更リクエストは ブランチ です。メインコンテンツの履歴を保ちながら、同時編集に使用できます。GitHub のプルリクエストや GitLab のマージリクエストを使ったことがある人にはおなじみの仕組みです。
公開済みの docs site のコンテンツを編集したい場合は、まずセクションで変更リクエストを開く必要があります。
変更リクエストでは、セクション内のコンテンツを追加、編集、削除したうえで、チームにレビューを依頼し、変更をメインコンテンツにマージして公開済み docs site を更新できます。
ブランチの概要
変更リクエストを開くと、その特定時点のコンテンツのコピーが作成されます。これは「ブランチ」と呼ばれることもあります。変更リクエストをマージするまでは、加えた変更はメインコンテンツには表示されません。
ブランチの利点は、チームメイトが互いに干渉することなく、あなたと同時にそれぞれの変更リクエストを作成、編集、マージできることです。もし誰かがあなたと同じコンテンツを編集した場合でも、GitBook がマージ前に競合の解決を案内します。
レビュー
レビューは、確認作業を促し、ドキュメントの品質と正確性の向上に役立ちます。
変更をマージして docs site 上で公開する前に、変更リクエストにレビューを依頼できます。変更リクエストにタイトルと説明を追加すると、レビュー担当者に文脈を伝えられます。
レビュー担当者は、変更リクエストの diff を確認でき、新規、変更、削除された内容がすべて強調表示されます。組み込みのコメント機能を使ってページ上で直接フィードバックを残すこともでき、その後、変更リクエストを承認するか、さらなる修正を依頼できます。
マージ
変更リクエストをマージすると、その中のすべてのコンテンツがメインブランチに追加され、変更は docs site にも公開されます。
変更リクエストをマージすると、セクションのバージョン履歴に新しいバージョンも作成されます。
ドキュメントの公開
コンテンツを docs siteとして公開すると、サイトにさらにコンテンツを追加したり、対象ユーザーを変更したり、見た目やその他の設定をカスタマイズしたりできます。
docs site の構成
サイトに追加のコンテンツを入れたい場合は、用途の異なる 2 つのオプションがあります。セクションとバリアントです。
サイト構成内のセクション
セクションを使うと 1 つの docs site に複数の異なる種類のドキュメントを追加できます。たとえば、この docs site のように、1 つの docs site で製品ドキュメント、API リファレンス、ヘルプセンター、変更履歴をまとめてホストできます。
新しいセクションを追加すると、サイト上部のナビゲーションバーが拡張され、それぞれのセクションにバー上で独自の項目が割り当てられます。また、セクションを グループ にまとめてナビゲーションバーにドロップダウンメニューを作成することもでき、サイトに階層を持たせるのに最適です。
バリアント
バリアントは、 1 つの docs site に同じドキュメントの複数のバージョンを追加できるようにするためのものです。たとえば、ドキュメント全体を複数の言語にローカライズしたり、未更新のユーザー向けに製品の以前のバージョンを記載したりできます。
エンドユーザーは、サイト左側の目次上部にある言語ピッカーまたはバリアントピッカーを使って、これらのバリアントを切り替えられます。
サイトの対象ユーザー
公開時に、誰がドキュメントを閲覧できるかを選択できます。新しいサイトの既定値は公開状態で、検索エンジンにインデックスされる設定です。
ただし、サイトへのアクセス権をより細かく制御したい場合は、 共有リンク または 認証付きアクセス.
共有リンクを使うと、プライベートリンクを作成して直接相手に共有することで、組織に招待せずに顧客やパートナーとコンテンツを非公開で共有できます。リンクを持っている人なら誰でもサイトにアクセスできます。
さらに厳密に制御したい場合は、認証付きアクセスを使うことで、閲覧する訪問者に認証を求めつつコンテンツを公開できます。有効にすると、GitBook は認証プロバイダーにコンテンツへのアクセス管理を任せます。これは、非公開コンテンツや、チームメンバーのみにアクセスを限定した社内ナレッジベースの公開に最適です。
適応型コンテンツと呼ばれる機能を使って、個々のページやブロックを誰に見せるかも制御できます。設定後は、あなたが決めたユーザー属性に基づいてコンテンツを表示または非表示にします。詳しくは Adaptive content のページ.
サイトのカスタマイズ
GitBook には docs site 向けの組み込みカスタマイズオプションがあり、ドキュメントの見た目や雰囲気を製品やブランドに合わせやすくなっています。
カスタマイズを何も適用しなくても、ドキュメントはそのままで十分に美しく表示されます。ただし、ロゴ、アイコン、色のカスタマイズ、カスタムフォントの追加、あるいは製品に匹敵するほど魅力的に見せるための組み込みテーマの選択も可能です。
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 社分のすべてのコンテンツと docs site が含まれます。1 つのアカウントで 1 つまたは複数の組織のメンバーになれ、サイドバー上部の組織メニューを使って切り替えられます。
メンバー
メンバーは組織内の個々のユーザーです。組織には好きなだけメンバーを追加でき、それぞれに必要なアクセス権に合った権限を設定できます。
権限
権限を使うと、組織メンバーのアクセスレベルを決められます。メンバーが組織に参加すると、Editor や Viewer などの役割を割り当てます。これらの役割が、組織内のすべてのコンテンツに対する権限を定義します。ただし、コンテンツ単位でこれらの権限を上書きすることもできます。たとえば:
Viewer ロールの人に、特定のコンテンツ 1 件だけ編集権限を与えることができます
特定の機密コンテンツや非公開コンテンツへのアクセスを制限し、組織内の一部メンバーのみにアクセスを付与できます。
詳しくは 権限と継承のページをご覧ください.
最終更新
役に立ちましたか？