こんにちは、屋根裏エンジニアこと 技術1課の折戸です。
最近めっきり寒くなってきたので、屋根裏にストーブを置くかエアコンを設置するか悩んでいます。
さて、エンジニアとして働く方々にとって、社内外を問わずドキュメントに触れる機会が多いかと思います。
そして、あれ？この内容もしかして間違ってるのでは、、と思った経験はないでしょうか？
内容まではともかく、誤字や脱字、リンク切れなどは目にしたことはきっとあるはず。
そしてそれはAWSの公式ドキュメントでもよく起こります。
これまではそんな機会に遭遇してもスルーしちゃっていましたが、今回はフィードバックをやってみましたのでその方法と結果をお伝えします。
経緯
とある作業でEC2でWindowsサーバーを構築していました。
恥ずかしながら当時は経験が浅く、
普段よく利用しているED22519のSSH鍵がWindowsサーバーに対応していないことを知らずにインスタンスを起動してしまい、SSH接続ができない状況に陥りました。
いろいろと試行錯誤した結果SSH鍵が原因であることを特定し、RSA鍵でインスタンスを作成し直して問題は解決しました。
しかしその後、ふとAWSの公式ドキュメントをちゃんと確認していればすぐに問題が解決できていたのかどうかが気になり、ドキュメントを確認しました。
すると、今は更新されていますが、
Amazon EC2 supports 2048-bit SSH-2 RSA keys for Windows instances.
↑、この部分が
The keys that Amazon EC2 uses are ED25519 or 2048-bit SSH-2 RSA keys.
↑、当時はこのような記載内容となっていました。
The keys that Amazon EC2 uses are ... ですが、 「Amazon EC2 のキーペアと Windows インスタンス」の説明ページに「ED25519」の記載があることで、自分と同じ様にようにハマってしまう方がいるかもしれません。
というわけで、フィードバックすることに。
方法
以下の方法で簡単にフィードバックを送信できます。
1.フィードバック送信フォームへ
AWS公式ドキュメントページの、フィードバックしたいページの右上もしくは一番下あたりのリンクからフィードバック送信フォームへ遷移します。
2.フィードバック内容を入力
日本語のドキュメントページからでも英語のフォームへリンクされるので、英語で入力しましょう。（拙い英語でもきっと大丈夫です！！）
※日本語で対応してもらえるかどうかは確認していません。
項目は以下のとおりです。
Topic
フィードバック対象のページURLが表示されるので、間違いないことを確認します。
今回は http://docs.aws.amazon.com/en_us/AWSEC2/latest/WindowsGuide/ec2-key-pairs.html が表示されていました。
Type of issue:
以下の中から適切な項目を選択します。
- Kudos（称賛）
- Grammar or spelling（文法またはスペル）
- Broken link（リンク切れ）
- Inaccurate content（不正確なコンテンツ）
- Display and design（ディスプレイとデザイン）
今回はInaccurate content（不正確なコンテンツ）を選択しました。
How can we make the documentation better?
どうすれば改善できるかを記載します。
訂正依頼のフィードバックの場合、可能な限り具体的に代替案などを提案すると良いと思います。
今回は日本語のページとの相違があるようにも思えたので、以下の様に記載しました。
> The keys that Amazon EC2 uses are ED25519 or 2048-bit SSH-2 RSA keys.
In this line, the ED25519 key cannot decrypt the Windows server password and should be deleted.
By the way, it has already been deleted from the Japanese page.
https://docs.aws.amazon.com/ja_jp/AWSEC2/latest/WindowsGuide/ec2-key-pairs.html
What are you trying to do?
当該ドキュメントページを見て何をしようとしていたのかを記載します。 今回は特に触れなくても良いと判断し、空白としました。
Contact Information (optional)
フィードバックに対する返信が欲しい場合、受信が可能なメールアドレスを記載します。
Security Check
フォームページでよくあるセキュリティチェックです。
画面に表示された画像もしくは読み上げられる音声を元に記載します。
以上の内容を入力し、Submit Feedback よりフォームを送信します。
結果
フィードバック送信から約5日後にメールの返信がありました！
見事受け入れられ、先述の通りにドキュメントが更新されました！！
以下、返信メールの内容です。
Hi, and thanks for reaching out to AWS Documentation.
〜〜（中略）〜〜
Hi, thanks for pointing this out. We do mention that ED25519 is not supported for Windows instances on the referenced page, but I agree it could be made more clear. I removed references to ED25519 on the page, except for notes about nonsupport. Changes will appear live later this afternoon.
Thanks!
Samantha
微力ながらAWSに貢献！！！
サマンサさん、ありがとう！！！！
終わりに
AWSは毎日のように機能のアップデートや新サービスがリリースされており、とても膨大で素晴らしいクラウドサービスです。
反面、そのドキュメントを管理することはAWSの中の人でも大変な作業かと思われます。
AWSを利用するユーザーがフィードバックしてドキュメントが洗礼されることでAWSのサービス発展に貢献できます。
ぜひみなさんもドキュメントの間違いに気づいた際は、気軽にフィードバックをやってみてはいかがでしょうか。
ちなみに
今回は英語のページに対してフィードバックをしました。
なぜ英語なのかというと、以下の記事でもご紹介のとおり、
ドキュメントを英語で確認する
AWSエンジニアとして最新の状態、誤訳のない内容を確認することは大切です。
また、今回は日本語を含めて英語以外の言語ページは同じように更新されなかったようです。。 次の機会に追加フィードバックをやっておこうと思います！！
