新しい Cloud SDK のリファレンス用ドキュメントで生産性を高める

※この投稿は米国時間 2022 年 8 月 2 日に、Google Cloud blog に投稿されたものの抄訳です。

Google Cloud は、以前から Cloud SDK の一部として、サービスのクライアント ライブラリを提供してきました。クライアント ライブラリは、サポート対象言語の自然な規則やスタイルを使用しているため、快適な開発のためにご活用いただけます。今年、Google Cloud は Cloud クライアント ライブラリの新しいバージョンの一般提供を開始しました。この新しいクライアント ライブラリは、API との連携を簡素化し、効果的なコーディングを開始するためのハードルを下げるため、Cloud API にプログラマティックにアクセスするための推奨オプションとなっています。

各ライブラリのリファレンス用ドキュメントは、クラス、インターフェース、メソッドのコード スニペットなどに関する便利な情報を提供しているため、非常に重要です。新しい Cloud クライアント ライブラリでは、これまで多くの場合、googleapis.dev などの別のサイトにリファレンス用ドキュメントが置かれていました。

Google Cloud クライアント ライブラリのリファレンス用ドキュメントの新しい場所

Google Cloud は Cloud SDK をより良く、より一貫性のあるものにするための取り組みの一環として、本日、これまで分散していたすべてのリファレンス用ドキュメントを cloud.google.com にまとめることを発表します。cloud.google.com/sdk に、多数ある言語別のリファレンス用ドキュメントの一覧を掲載しています。

リファレンス用ドキュメントを 1 か所に集約し、多くの新機能と利点を提供します。

ドキュメントの一元化

googleapis.dev などに分散していた Cloud クライアント ライブラリのリファレンス用ドキュメントがすべて cloud.google.com でご覧いただけるようになります。今後数週間のうちに、googleapis.dev にあるリファレンス用ドキュメントをこちらにリダイレクトし、使いやすくする予定です。

自動生成されたドキュメントとコードサンプル

自動生成機能によって、新しいクライアント ライブラリがリリースされるたびにドキュメントが自動的に更新されます。より一貫性のある正確な技術資料を、1 か所で見つけられるようになります。  

また、リファレンス ページにはコードサンプルを掲載しました。コードサンプルは、該当するクラスやメソッドのすぐ下に記載されています。Cloud クライアント ライブラリをプロジェクトで使用するために必要なリソースを、これまで以上に簡単に見つけることができます。

レイアウトの簡略化

開発者として適切なドキュメントを探すことは、フラストレーションを伴う作業になりがちです。Cloud クライアント ライブラリのリファレンス用ドキュメントの新しい保存場所では、開発者の皆様が整理された状態で開発に集中できるように、エクスペリエンスを簡素化しました。レイアウトを一新し、フォントによる情報の階層化、目次、タグ、パンくずリスト、ハイライト表示、説明文などを充実させ、必要なものをすぐに探し出せるようにしました。

検索オプション

上部の検索ナビゲーション バーで、すべてのリファレンス用ドキュメントを検索できます。現在、リファレンス用ドキュメントは cloud.google.com で公開されており、検索はドメイン内のすべてのページにまたがるように統合されています。検索結果は、ページ、リファレンス用ドキュメント、プロダクト ページと、ページの種類ごとに分けられます。これにより、ページタイプ別に関連性の高い検索結果が明確になり、長い検索結果リストの中でスクロールする時間を削減できます。

フィルタ

各リファレンス用ドキュメントでは、左側のナビゲーション バーに、特定の言語に関するすべてのリファレンス用ドキュメントのリストが表示されます。バーの上部にあるフィルタ検索ボックスで、必要なリファレンス用ドキュメントを探し、選択できます。フィルタ ボックスにお探しのリファレンスの名前を入力するだけで、キーワードにマッチした結果を絞り込むことができます。

目次

新しいインターフェースでは、必要なセクションを探してテキストのリストをスクロールする必要がなくなりました。右側のパネルに目次が表示されているため、ワンクリックで目的のセクションに移動できます。

ダークモード

人気のダークモードも利用可能です。Google Cloud の開発者は、コードテーマをダークモードに切り替えることができるようになりました。そのため、自分の作業に最適なカラースキームを柔軟に使用できます。また、ライトモードとダークモードの切り替えもボタン 1 つで可能です。 

コードの直接編集

新しくリファレンス用ドキュメントをまとめた cloud.google.com では、コードサンプル内で直接変数を編集し、ボタンをクリックするだけで編集したコードサンプルをコピーできます。これにより、コードをエディタにコピーし、変数を編集し、またコピーする、という余分な手順を省くことができます。

オープンソースを通じた還元

Google Cloud は、ツールやソースコードの多くをオープンソース化し、開発者による参加、機能のリクエスト、問題提起を可能にすることに尽力しています。また、API へのインターフェースを提供するクライアント ライブラリのインストール方法は、GitHub リポジトリで公開されています。

時間を節約し、開発者の生産性を向上させる

Cloud クライアント ライブラリのリファレンス用ドキュメントを集めた cloud.google.com では、ご関心のある言語やプロダクトに関係なく、Google Cloud のすべてに対応する使い慣れた単一のインターフェースをお使いいただけます。また、検索、フィルタリング、シンプルなナビゲーションなどの豊富な機能を備えた cloud.google.com 全体の UI エクスペリエンスにも統合されています。ダークモード、コード内編集、ワンクリックでのコードのコピー、構文のわかりやすいハイライト表示などの機能は、開発者が開発者のために作成したものです。Cloud クライアント ライブラリのリファレンス用ドキュメントの集約により、合理化されたエクスペリエンスで皆様の生産性に貢献できることを願っています。

ご意見やご感想は、各ドキュメントのページ下部にある [フィードバックを送信] ボタンからご送信ください。また、@stephr_wong へもお気軽にご連絡ください。

デベロッパー向けニュースやツールにご興味のある方は、Developer Center にアクセスし Google Cloud Innovators にご参加ください。