Google Cloud のドキュメントを最大限に活用するためのヒント
Google Cloud Japan Team
※この投稿は米国時間 2023 年 1 月 12 日に、Google Cloud blog に投稿されたものの抄訳です。
Google Cloud の実務担当者は通常、ガイド、コマンド、チュートリアルなど、さまざまなドキュメントを読んで調べることにかなりの時間を費やしています。ドキュメント チームは、Google Cloud のドキュメントを使用してより簡単に生産性を向上させることができるように、長年にわたりさまざまな機能を導入してきました。
ここに挙げるヒントは、よくご存じの方もいらっしゃるかもしれませんが、1 つでも皆様のお役に立てるものがあればと思い、ご紹介させていただきます。ここでは、私が個人的に役立つと思うヒントを順不同で列挙しています。
インタラクティブなチュートリアル
これはドキュメントの優れた機能で、インタラクティブなチュートリアルが Google Cloud コンソールに直接表示され、一連の手順としてチュートリアルを完了できます。Google Cloud コンソールで上部のアクションバーにあるサポート アイコンを使用して、さまざまなチュートリアルを利用できます。
検索
Google Cloud コンソールの上部にある検索バーでは、さまざまなプロダクトのサービス、ドキュメント ページ、チュートリアルに加えて、Google Cloud のリソース(Compute Engine VM 名など)も効率的に検索できます。
左上のハンバーガー メニューとそれに続く左ナビゲーション バーから特定のプロダクトのページを見つけることもできますが、特定のプロダクトに移動するには、検索バーを使用するのがおそらく最も手っ取り早いでしょう(「ピン」機能を利用して、よく使用するプロダクトを左ナビゲーション バーのリストの一番上にロックしているパワーユーザーの方はすばらしいです)。
次のスクリーンキャストは、特定のプロダクトの検索方法を示しています。特定のプロダクトに移動する方法だけでなく、さまざまなセクション(チュートリアル、Google Cloud のリソースなど)に分けて結果が表示されることにもご注目ください。
すべてのプロダクトとその関連ドキュメントをすぐに確認したい場合は、左ナビゲーション バーにある [すべてのプロダクトを表示] リンクを使用します。次のスクリーンキャストはその方法を示しています。
チュートリアル、クイックスタート、リファレンス ガイドがさらに必要な場合
ドキュメント間を移動しているときに、プロダクトごとに利用できるチュートリアル、クイックスタート、リファレンス ガイドのリストがあることにお気付きになったかと思います。特定のプロダクトに関する詳細情報を取得するには、いくつかの方法があります。
まず、一部のプロダクト ページに [学ぶ] アイコンがあることにご注目ください。以下は Compute Engine プロダクトのホームページの例です。
[学ぶ] ボタンをクリックすると、そのプロダクトに関連する一連のドキュメントにアクセスできるようになります。
ときには、インタラクティブなチュートリアルをもう少し試してみたい場合もあるでしょう。前のスクリーンキャストでご覧いただいたように、上部のアクション バーにあるサポート アイコンを使用して [チュートリアルを開始] リンクを選択すると、いくつかのインタラクティブなチュートリアルにアクセスできるようになります。ただし、このリストに表示されるのは一部のみで、他にも利用可能なインタラクティブ チュートリアルがあります。それらを利用するには、次のようにします。
たとえば、IAM について詳しく知りたいため、このサービスで利用できるさまざまなインタラクティブなチュートリアルを確認したいとします。上部のメインの検索バーに移動し、「IAM」と入力します。これにより、前にご覧いただいたような検索結果のリストが表示されます。
上図に示すように、[ドキュメントとチュートリアル] セクションにいくつかの結果が表示されます。ここでのキーワードはインタラクティブなチュートリアルです。
[ドキュメントとチュートリアルの結果をさらに表示] をクリックすると、検索結果ページが表示されます。そこでインタラクティブなチュートリアルのみが表示されるように、さらに絞り込むことができます。お気に入りのドキュメント ページを保存
各ドキュメント ページの上部に表示されるブックマーク アイコンをクリックすると、ドキュメント ページのコレクションに保存され、Google プロフィールから簡単に参照できるようになります。
たとえば、以下は、Compute Engine で VM インスタンスを作成して開始する方法に関するドキュメント ページです。このドキュメントをブックマークするとします。必要な操作は、以下に示すようにブックマーク アイコンをクリックするだけです。
これを保存したページに保存するか、新規コレクションを作成してそこに保存するかを選択できます。上記の私のケースでは、「Compute Engine」という名前の新規コレクションを作成し、その下にこのページをブックマークすることを選択しました。
ブックマークしたすべてのページにアクセスするには、どうすればよいのでしょうか。上部バーの Google プロフィール写真の横にあるその他アイコンをクリックすると、そのアカウントに関連付けられている Google デベロッパー プロフィールにアクセスできるようになります。次に示すように、表示されるオプションに [保存したページ] があります。
このページにアクセスすると、保存したページが次のように表示されます。
作成したコレクションのいずれかをタップすると、その下にすべてのブックマークが表示されます。
フィードバック
お客様のご意見は貴重であるため、Google Cloud ドキュメントではお客様が簡単にフィードバックを送信できるようにしています。ドキュメント ページに [フィードバックを送信] ボタンが表示されることにご注目ください。これをクリックすると、特定のページまたは特定のプロダクトのドキュメント全般に関するフィードバックを送信できます。
対話型コードサンプル
これは今でも私のお気に入り機能の一つで、特にさまざまな gcloud コマンドを試しているときには、開発者の生産性が何倍にも向上します。具体的には、これは一連のコマンドで繰り返す必要がある Project ID や Region などのプレースホルダ変数をコマンド内で使用する機能です。
この機能は 2 年以上前に導入されたもので、こちらのブロク投稿で詳しく説明されています。以下に、そのブログ投稿でこの機能について説明されている箇所のスクリーンキャストとテキストの一部を抜粋して掲載します。
「ページに同じプレースホルダ変数を持つ複数のコードサンプルがある場合は、変数を置き換えるのは一度だけですみます。たとえば、PROJECT_ID 変数を独自の Google Cloud プロジェクト ID に置き換えると、PROJECT_ID 変数のすべてのインスタンス(ページの他のコマンドライン サンプルを含む)は同じ Google Cloud プロジェクト ID を使用します。」
ここでご紹介したヒントが皆様のお役に立てば幸いです。インタラクティブなチュートリアルを試してみたい方は、Compute Engine のクイックスタートをお試しください。
皆様も Google Cloud のドキュメントを使用する際に役立つ独自のヒントをお持ちかと思います。Twitter(@iRomin)でそれらをぜひ共有してください。投稿をお待ちしております。