AWS再入門ブログリレー2022 AWS ドキュメント編

弊社コンサルティング部による『AWS 再入門ブログリレー 2022』 12日目のエントリで、テーマは、「AWSドキュメント」です。AWSドキュメントについて、調べたことがなかったので、再入門してみました。ご参考にしていただければ幸いです。
2022.02.17

こんにちは!AWS事業本部コンサルティング部のたかくにです。

当エントリは弊社コンサルティング部による『AWS 再入門ブログリレー 2022』の12日目のエントリです。

このブログリレーの企画は、普段 AWS サービスについて最新のネタ・深い/細かいテーマを主に書き連ねてきたメンバーの手によって、 今一度初心に返って、基本的な部分を見つめ直してみよう、解説してみようというコンセプトが含まれています。

AWSをこれから学ぼう!という方にとっては文字通りの入門記事として、またすでにAWSを活用されている方にとってもAWSサービスの再発見や2022年のサービスアップデートのキャッチアップの場となればと考えておりますので、ぜひ最後までお付合い頂ければ幸いです。

では、さっそくいってみましょう。12日目のテーマは「AWS ドキュメント編」です。

AWSドキュメントとは

AWSドキュメントは、AWSを使用するための使用方法(ユーザーガイド、デベロッパーガイド、API リファレンス等)、チュートリアルがまとまったドキュメントのことです。

AWS のドキュメント

ガイドの種類

各サービスには、基本的に「ユーザーガイド」、「デベロッパーガイド」のどちらかが存在し、ガイドを読むことで、AWSサービスの仕様理解に努めることができます。

ガイドには、他にも「管理ガイド」、「入門ガイド」、「リファレンスガイド」などが存在します。

EC2 ドキュメント画面

Lambda ドキュメント画面

API リファレンス

各サービスにはガイドの他に、APIリファレンスが収録されており、サービスAPIへの具体的な、アクセス方法が記載されています。

AMIを作成するためのAPI

設定編

言語選択を「日本語」以外にする

リファレンスによっては、自動翻訳の影響で日本語として、読みづらい部分があります。

そのようなケースでは、言語選択を「日本語」から「English」に切り替え、翻訳元のリファレンスを読むことで、よりスムーズに理解できます。

テーマ設定を変更する

テキストのテーマ」、「コードのテーマ」をライト、ダークに変更できます。

デフォルトでは、どちらのテーマもライトが採用されていますが、ダークの設定もかっこいいなと思います。

リクエスト編

翻訳のリクエスト

リファレンスによっては、英語のみで提供されている場合があります。

日本語で読みたいと思った場合は、「翻訳のリクエスト」を送ることができます。

日本語対応になった経験はありませんが、どうしても日本語で読みたい時に押す感覚で、リクエストしています。

フィードバック

ドキュメントでは、リンク切れ、誤字脱字など具体的なフィードバックを送ることができます。 不備を発見した場合は、画面右上部の「フィードバック」から、フィードバックを送ってみましょう。

Good, Badボタン

ドキュメントには、YoutubeやTwitterライクに、Goodボタン、Badボタンが搭載されており、判断基準としては、「役に立った」かどうかで評価できます。

個人的には、ドキュメントの「どの部分」が役に立ったなどの詳細の部分をリクエストできればいいなぁと思いました。

検索編

知りたい情報に最短でたどり着くには...

個人的には、以下のステップでドキュメントを追っています。

  1. 検索エンジンで調べたいことを検索する(例:「ec2 default user」など)

  2. 画面上部の検索バーから、「ec2 default user」と検索を行う

ステップ2を、取り入れてから個人的に、理解の幅がより一層広がったため、時間に余裕がある時は積極的に取り入れてみてください。

小ネタ:検索バーで使用しているサービスの違い

本記事を作成しているにあたり、初めて知ったのですが、検索バーで使用するサービスが言語によって違いました。

サービスの違いを実感できるほど、ドキュメントを読み込めて無いですが、日本語もぜひ対応して、検索の最適化が進むと良いなと思います。

より正確な情報にたどり着くには...

基本的に、AWSドキュメントは、英語から更新されます。

そのため、より正確に情報を探すには、日本語のみならず、英語のドキュメントも読み、整合性が取れているかを確認する必要があります。

誤答を回避すべく、自信がない時ほど「英語でドキュメントを読むこと」を意識してみてください。

更新編

ドキュメント履歴

各サービスのドキュメントには、「ドキュメント履歴」が存在します。

ドキュメントの更新があった場合は、ドキュメント履歴に「いつ、どのような更新」があったのか、記載されるため興味があれば、定期的に確認してみましょう。

RSSの使用

各ドキュメントには、RSSフィードを設定可能です。

ドキュメントの更新をトリガーに、Slackに通知するなどカスタマイズが可能です。

ご自身が、最先端に知りたいトピックは、RSSフィードで追ってみましょう。

弊社ブログ:導入3分!RSSフィード29種一括登録でAWS最新情報を漏れなくチェック

最後に

以上、『AWS 再入門ブログリレー 2022』の12日目のエントリ『AWSドキュメント』編でした。

再入門として、馴染みがある部分を狙ってみましたが、新しい発見はございましたでしょうか。

他にも、みなさんのおすすめの検索方法がございましたらぜひ、「Twitter」や「はてブ」で、シェアしていただけますと幸いです。

明日、2/18 金曜日は、森田さんの「Amazon SageMaker編」の予定です!

AWS事業本部コンサルティング部のたかくにでした!