😽

Google Cloud ドキュメントの歩き方

に公開

本稿は JP_Google Developer Experts Advent Calendar 2025 の 11 日目の記事です。

はじめに

Google Cloud の知識を得るために公式ドキュメントは欠かせませんが、ドキュメントの読み方がよくわからず上手く活用できていないエンジニアの方々もいるのではないでしょうか。本稿はそんなみなさんにとって Google Cloud 公式ドキュメントを最大限活用し、効率的に知識を得るための歩き方を説明します。

本稿では、Google Cloud 公式ドキュメントの歩き方として、公式ドキュメントの構造とホームポジション、そしてホームポジションへの辿り着き方を説明します。また、公式ドキュメントを読むための tips や他の信頼できるリソースを紹介します。

ホームポジション

Google Cloud 公式ドキュメントはプロダクトごとに用意されています。各プロダクトの公式ドキュメントのうち「ガイド」のページがホームポジションになります。目印は上部にガイド、リファレンス、サンプル、リソースなどのタブがあり、左部のメニューには公式ドキュメントで扱っている様々なトピックへのリンクが一覧になっています。また、URL は https://docs.cloud.google.com/{product}/docs/* という形式になります。例えば Cloud Run であれば https://docs.cloud.google.com/run/docs/(省略) となります。

Tabs

例えば次の画像のようなページがホームポジションです。

Cloud Run Home
Cloud Run ドキュメントのホームポジション

BigQuery Home
BigQuery ドキュメントのホームポジション

ホームポジションへの辿り着き方

ホームポジションへ辿り着くことができ、ドキュメント構造が把握できていれば、欲しい情報にアクセスすることは難しくありません。しかし、ホームポジションに辿り着くまでが難しいというケースがあります。検索してもガイドへの直リンクがなかったり、各プロダクトホームからの導線が異なっていたりすることがホームポジションへのアクセスを難しくしている要因です。

以下で説明する 2 パターンをおさえておけば、大半のプロダクトでホームポジションに辿り着くことができるようになります。

ドキュメントホームから探す

全プロダクトの公式ドキュメントへのリンクを集めたホーム (docs.cloud.google.com) から各プロダクトのホームポジションへアクセスするパターンです。手順は以下の通りです。

  1. ドキュメントホームにアクセスする
  2. プロダクトを検索しクリックする
  3. 「プロダクトのドキュメントを読む」ボタンをクリックする

以下、スクリーンショット付きで詳しく説明します。

まずはホームにアクセスして、「本日はどのようなご要件でしょうか?」を無視して「プロダクトを検索」に目的のプロダクト名を入力しましょう。

Documentation Home

そうするとプロダクト名が表示されるのでクリックします。

Documentation Home (searched)

「プロダクトのドキュメントを読む」というボタンがあるのでそれをクリックします。「プロダクトのドキュメントを読む」ボタンがない場合、上部に「ガイド」タブがあるのでそれをクリックしてください。また、プロダクトによってはこの手順を踏まずに辿り着く場合もあります。

Documentation Home (button)

プロダクトホームから探す

プロダクト名で Google 検索をしてドキュメントを探す場合はプロダクトホームが入口になることが多いでしょう。プロダクトホームからは次の手順でホームポジションに遷移します。

  1. Google 検索でプロダクトホームにアクセスする
  2. 左下のドキュメントへのリンクをクリックする
  3. 「プロダクトのドキュメントを読む」ボタンをクリックする

以下はスクリーンショット付きの説明です。

まずは Google 検索します。

Google Search

プロダクトホームの左下にドキュメントへのリンクがある場合はそれをクリックしてホームポジションを目指しましょう。

Product Home

左下にドキュメントへのリンクがないプロダクトホームはおそらくこのような見た目をしているはずです。

Product Home without link

このようなタイプのプロダクトホームは左メニューの「ドキュメント」をクリックして、下部にある「すべてのプロダクト ドキュメントを見る」というリンクをクリックしてください。

Product Home link

ドキュメント構造

各プロダクトの公式ドキュメントはそれぞれが概ね以下のような共通の構造とコンテンツを持ちます。この構造を把握しておくことで、ホームポジションから目的の情報へ素早くアクセスできるようになります。

  • ガイド
    • プロダクトの概要説明
    • 必要な概念の説明
    • チュートリアル
    • 設定方法
    • 利用手順
    • ベストプラクティス
    • トラブルシューティング
  • リファレンス
    • API リファレンス
    • モニタリング指標
    • クライアントライブラリ リファレンス
    • gcloud リファレンス
    • その他、各種設定や DSL 等のリファレンス
  • サンプル
    • 様々なユースケースにおけるサンプルコードや設定
  • リソース
    • 料金
    • 割り当てと上限 (quota)
    • リリースノート
    • SLA
    • その他、サポートバージョンなど

多くの情報はガイドの中から探すことになります。API リファレンスや料金はガイドではなく別タブにあると覚えておけば迷わずドキュメントを読めるようになります。

公式ドキュメント tips

上記以外に公式ドキュメントを読む上で役立つ tips を紹介します。

英語版を参照する

Google Cloud の公式ドキュメントは多言語化されていますが、オリジナルのドキュメントは英語で、それ以外の多くは機械翻訳です。そのため英語以外のドキュメントは元のドキュメントと意味が変わっていたり、内容が古かったり、フォーマットがバグっていたりすることがよくあります。

もちろん日本語版を読んでも問題ありませんが、内容に違和感を覚えたり最新の情報が反映されていないと感じたりしたときは英語のドキュメントを参照しましょう。

一貫性のなさを覚えておく

辿り着き方からもわかるように、プロダクト間でドキュメント構造や導線に一貫性がありません。多くのプロダクトで似た構造を持っており、大枠を把握しておけば問題なく読めるようになります。しかし、料金情報がリソースタブに無くガイド内にだけあるような場合もあったりするので、一貫性がないということを念頭に置きつつ柔軟に探すようにしましょう。

特殊なドキュメントがあることを覚えておく

一貫性がないという話の特殊ケースですが、プロダクトによっては本稿の内容と大きく異なるドキュメントを持つことがあります。例えば Firebase はそれ単体で独立したドキュメントサイトがあります。Firestore などに至っては Firebase 版ドキュメントと Google Cloud 版ドキュメントがあります。前述した構造を参考に、自分はどこで何を見ているのかということを常に把握しつつドキュメントを読むといいでしょう。

プロダクト内でブレークダウンする

プロダクトによってはホームポジションでリファレンス等のタブがなく、ガイドも少ないというものがあります。そういうプロダクトの場合、1 つブレークダウンすると正しいホームポジションに遷移できる場合があります。

例えば、Cloud SQL はデータベースエンジンを選択するとホームポジションに遷移します。App Engine は環境を選ぶとホームポジションに遷移します。

Cloud SQL home
データベースエンジンを選ぶ前はメニューが少ない

Cloud SQL home
データベースエンジンを選ぶと真のホームポジションに遷移できる

公式ドキュメント以外のリソース

公式ドキュメント以外にも様々なリソースがあります。いくつか紹介します。

googleapis/googleapis

https://github.com/googleapis/googleapis

Google が公開している API 定義が格納されている GitHub リポジトリです。内容は公式ドキュメントの API リファレンスとほぼ同じですが、Protocol Buffers/gRPC に慣れているエンジニアであれば遥かにこちらのほうがわかりやすいです。

各言語の client library のリファレンス

Client library の各言語のリファレンスです。例えば Go であれば pkg.go.dev、Java であれば javadoc.io などです。そういったリファレンスが用意されていない言語もあります。公式ドキュメントにも client library のリファレンスがありますが、あまり使い勝手がよろしくないので言語ごとにリファレンスがある場合はそちらを利用するとわかりやすいでしょう。

Client library のソースコード

Client library のソースコードです。公式ドキュメントのガイドを読んでもわからない、リファレンスを読んでもわからない、というケースでソースコードを読むと解決する場合があります。また、未発表の新機能がソースコードで見えることもあります。困ったときはソースコードを参照してみるのもいいでしょう。

アーキテクチャセンター

https://docs.cloud.google.com/architecture/deployment-archetypes

プロダクトごとではなく、Google Cloud 全体のベストプラクティスやリファレンスアーキテクチャが集約されたドキュメントです。

Well-Architected Framework には Google Cloud よりさらに広いスコープで優れた設計・運用についてまとまっています。例えばアプリケーションはモジュラー設計を採用せよということも書いてあります。

デプロイアーキタイプ にはゾーン、リージョン、マルチリージョン、グローバルの使い分けが説明されています。

ランディング ゾーン設計には Google Cloud を組織で使い始める際に必要なアカウントの作成方法、リソース階層の設計方法、ネットワークの設計方法などが書かれています。

ベストプラクティス以外にも様々なリファレンスアーキテクチャが用意されています。複数のプロダクトを組み合わせたものも多いので大きなシステムを作る際の参考になるでしょう。

重要なベストプラクティスが詰まっていますが、使い始める前にすべて読むには量が多いので時間があるときに読み物として読むのがおすすめです。

リリースノート

https://docs.cloud.google.com/release-notes

Google Cloud 全体のリリースノートです。ここを見ておけば Google Cloud に関する最新情報を得られます。

その他

その他にも公式ブログ、企業ブログ、個人ブログ、イベントセッションのアーカイブ動画など様々なリソースがあります。これらも非常に有用ですが、必ず投稿日などで鮮度をチェックしましょう。

企業ブログや個人ブログなどはポイントを絞ってわかりやすく説明されているものも多いので非常に参考になります。しかし、内容が古くなっている記事も非常に多いです。Google Cloud のプロダクトは 1 年経てば変わっていることも多いので、ブログで概要を把握して詳細は公式ドキュメントで調べるような使い方がおすすめです。

本稿もこのセクションに該当します。1 年後には内容が古くなっているかもしれません。

おわりに

Google Cloud の公式ドキュメントの歩き方として、まず辿り着くべき公式ドキュメントのホームポジション、ホームポジションへの辿り着き方、公式ドキュメントの構造、tips を紹介しました。また、公式ドキュメント以外のリソースについても紹介しました。Google Cloud を学んだり調べたりするときの参考になれば幸いです。

GitHubで編集を提案

Discussion