概念
GitBookの基本を学び、ユーザー向けの優れたドキュメントを作成・公開できるようにする
コンテンツの整理
スペース
スペースは、関連するページのコレクションに対して作業できるプロジェクトです。スペース内ではコンテンツの作成、グループやサブページによるページの整理、インテグレーションのインストールなどを行えます。
スペースを公開したい場合は、それをドキュメントサイトに追加して公開できます。ドキュメントサイトには好きなだけ多くのスペースを追加できます。したがって、コンテンツを構築するときは、製品ドキュメント、APIリファレンス、変更履歴、ヘルプセンター、その他ドキュメントに含めたいものごとに別々のスペースを作成し、それらすべてを1つのドキュメントサイトで公開できます。
また、主要なドキュメントの翻訳版を作成したり、製品の異なるバージョンごとに別のドキュメントを作成したりすることもあるでしょう。これらのそれぞれが独自のスペースを持ち、ユーザーが閲覧できるように単一のドキュメントサイトに追加することができます。
コレクション
コレクションは GitBook アプリ内のフォルダのように機能し、スペースをまとめてグループ化することでコンテンツの整理や保管を簡単にします。
コンテンツを整理できるだけでなく、コレクションはコンテンツレベルの権限を大規模に管理しやすくします。複数のスペースをコレクションに追加してコレクション全体の権限を設定することで、組織レベルの権限を上書きできます。
ドキュメントサイト
コンテンツをドキュメントサイトとして公開できます。公開されたドキュメントは、ブランド、分析、カスタムドメインなどでカスタマイズできるウェブサイトとして選択した対象に提供されます。
ドキュメントサイトは好きなだけ作成できます。すべてのサイトはサイドバーとアプリの「Docs sites」セクションに一覧表示され、そこで設定やカスタマイズオプションを変更できます。GitBook アプリでドキュメントサイトのすべての設定とオプションを管理できます。
サイト上のコンテンツは、GitBook 組織内のスペースから提供されます。新しいドキュメントサイトを作成するときは、新しいスペースを作成するか既存のスペースをリンクできます。ドキュメントサイトには1つのスペースを含めることも、翻訳や過去の製品バージョンを含む複数の異なるコンテンツを含むスペースを複数含めることもできます。
コンテンツの編集
GitBook のビジュアルエディタは、WYSIWYG（見たまま編集）インターフェースを使ってスペースにコンテンツを追加できるようにします。
ページ
ページはコンテンツを追加、編集、埋め込む場所です。ページは常にスペース内に存在し、スペースには好きなだけ多くのページを追加できます。
スペース内のページはエディタの左側にある目次に表示されます。ここで新しいページを追加したり、ページグループを作成したり、ページを他のページ内にネストしてサブページを作成したりできます。
ページの編集や追加方法がわかりませんか？
サイトが公開されている場合、スペースのコンテンツを変更する前に変更リクエストを作成する必要があります。 変更リクエストについては下記を参照してください.
ブロック
GitBook はブロックベースのエディタです。つまり、標準のテキストや画像からより高度でインタラクティブなブロックまで、さまざまな種類のブロックをページに追加できます。ページには好きな組み合わせのブロックを含めることができ、ページあたりのブロック数に制限はありません。
ブロックベースの編集により、ドラッグ＆ドロップでコンテンツを簡単に再配置したり、既存のコンテンツの途中に新しいブロックを追加したりできます。エディタのインターフェースを使って新しいブロックを作成するか、Markdown を使ってブロックを作成およびフォーマットできます。
GitBook で使用できるすべてのブロックを発見してください Blocks セクションで.
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 のマージリクエストを使う人には馴染みのある感覚です。
公開されているドキュメントサイトのコンテンツを編集したい場合は、まずスペースで変更リクエストを作成する必要があります。
変更リクエストでは、スペース内のコンテンツを追加、編集、削除し、チームにレビューを依頼して変更をメインコンテンツにマージして公開中のドキュメントサイトを更新できます。
ブランチの概要
変更リクエストを開くと、その時点のコンテンツのコピー（『ブランチ』と呼ばれることがあります）が作成されます。行った変更は変更リクエストをマージするまでメインコンテンツには表示されません。
ブランチの利点は、チームメイトが互いに干渉することなく、自分自身の変更リクエストを同時に作成、編集、マージできることです。もし誰かがあなたと同じコンテンツを編集している場合でも、マージする前に GitBook が競合の解決を案内します。
レビュー
レビューは監督を促し、ドキュメントの品質と正確性を向上させるのに役立ちます。
マージしてドキュメントサイトに変更を反映する前に、変更リクエストでレビューを依頼できます。変更リクエストにタイトルと説明を追加すると、レビュワーにコンテキストを提供できます。
レビュワーは変更リクエストの差分を確認でき、差分は変更リクエスト内で新規、変更、削除されたすべてを強調表示します。レビュワーは組み込みのコメント機能を使ってページ上に直接フィードバックを残すこともでき、その後変更リクエストを承認するか、さらなる変更を要求できます。
マージ
変更リクエストをマージすると、変更リクエスト内のすべてのコンテンツがメインブランチのコンテンツに追加され、その変更はドキュメントサイトにも反映されます。
変更リクエストをマージすると、スペースのバージョン履歴に新しいバージョンも作成されます。
ドキュメントの公開
コンテンツを ドキュメントサイトとして公開すると、サイトにさらにコンテンツを追加したり、対象を変更したり、見た目やその他の設定をカスタマイズしたりできます。
ドキュメントサイトの構成
サイトに追加コンテンツを加えたい場合、用途に応じた2つのオプション（サイトセクションとバリアント）があります。
サイトセクション
サイトセクションは、 1つのドキュメントサイトに複数の異なるタイプのドキュメントを追加することを目的としています。たとえば、単一のドキュメントサイトを使用して製品ドキュメント、API リファレンス、ヘルプセンター、変更履歴をホストすることができます（当該ドキュメントサイトのように）。
新しいサイトセクションを追加すると、サイト上部のナビゲーションバーが構築され、各セクションがバー上に独自のエントリを持ちます。サイトセクションをグループ化してナビゲーションバーにドロップダウンメニューを作成することもでき、サイトセクションに階層を追加するのに最適です。
バリアント
バリアントは、 同じドキュメントの複数のバージョンを単一のドキュメントサイトに追加するために設計されています。たとえば、ドキュメント全体を複数の言語にローカライズしたり、更新していないユーザー向けに過去の製品バージョンをドキュメント化したりする場合に便利です。
エンドユーザーは、サイト上で言語ピッカーやサイト左側の目次上部にあるバリアントピッカーを使って、これらのバリアント間を切り替えることができます。
サイトの閲覧対象
公開時にドキュメントを誰が見るかを選択できます。新しいサイトのデフォルトは公開状態で、検索エンジンにインデックスされる設定です。
ただし、サイトへのアクセスをより細かく制御したい場合は、次を使って閲覧対象を制限できます。 共有リンク または 認証付きアクセス.
共有リンクを使うと、組織に招待する必要なく顧客やパートナーとコンテンツを非公開で共有できます。プライベートリンクを作成して直接共有すれば、リンクを持つ誰でもサイトにアクセスできます。
さらに厳密な制御が必要な場合は、認証付きアクセスを使って、閲覧を希望する訪問者に認証を要求する形でコンテンツを公開できます。有効にすると、GitBook は認証プロバイダにアクセス制御を任せます。これはプライベートコンテンツやチームメンバーのみがアクセスすべき社内ナレッジベースの公開に最適です。
また、adaptive content（適応コンテンツ）という機能を使って、個々のページやブロックの表示をユーザー属性に基づいて制御することもできます。設定すると、決めたユーザー属性に基づいてコンテンツを表示または非表示にできます。詳細は次を参照してください Adaptive content ページ.
サイトのカスタマイズ
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 の組織は、個々の会社向けのすべてのコンテンツとドキュメントサイトを含みます。単一のアカウントで複数の組織のメンバーになることができ、GitBook アプリの左上のドロップダウンメニューでそれらを切り替えられます。
メンバー
メンバーは組織内の個々のユーザーです。組織内のメンバー数に制限はなく、各メンバーにはそのアクセスニーズに適した権限を付与できます。
権限
権限は、組織のメンバーのアクセスレベルを決定するものです。メンバーが組織に参加すると、Editor や Viewer のような役割を割り当てます。これらの役割は組織のすべてのコンテンツに対する権限を定義しますが、コンテンツレベルでこれらの権限を上書きすることもできます。例えば：
Viewer ロールのユーザーに特定のコンテンツだけ編集権限を与えることができます
特定の機密または非公開のコンテンツへのアクセスを制限し、組織の特定のメンバーだけにアクセスを付与できます。
詳細は次を参照してください 権限と継承のページ.
最終更新
役に立ちましたか？