【実施3分】新サービス大量だからこそ公式ドキュメントへのフィードバックをがんがんやりましょう! #reinvent

2019.12.08

「あれ、このドキュメント変じゃない?まぁ大量にサービスでてるから仕方ないかね…」

それを放置するなんて、もったいない!

今回のre:Invent2019では、ほぼすべての領域において大量の新サービスやアップデートが発表されました。それに伴い、AWSの公式ドキュメントも膨大な量が更新されています。自分も新サービスの検証がてら、公式ドキュメントを見ていたのですが、やはり人間がやることなので、公式ドキュメントに変な記載が若干ありました(スペルミス、遷移しないリンク、箇条書きのレベル違い)。

AWSがサービスを開発するにあたり、ユーザーからのフィードバックを非常に重視しているのは有名ですが、それは公式ドキュメントもしかり。AWSの公式ドキュメントには、ユーザーが非常に簡単にフィードバックする仕組みが整っているので、是非変だなと思ったことは積極的にフィードバックし、公式ドキュメントの品質向上に貢献してみましょう。

慣れれば、3分程度でフィードバックできますよ。

ドキュメント、変なんみつけたで…!!

  ( ゚д゚) ガタッ
  /   ヾ
__L| / ̄ ̄ ̄/_
  \/   /

公式ドキュメントフィードバック方法(画面遷移)

実施手順は非常に簡単です。最近AWSの公式ドキュメントは新バージョンがベータリリースされている状態で、フィードバックのUIが新旧バージョンでいくらか異なります。

現行バージョン

ドキュメントをページの右下にフィードバックボタンが設置されているので、こちらをクリック。

新バージョン(ベータ)

ドキュメントページの右上にフィードバックボタンが設置されているので、こちらをクリック。

公式ドキュメントフィードバック方法(入力)

フィードバック画面は、遷移元のドキュメントページのバージョンに関わらず一定です。

Topic

ここには、フィードバック対象ドキュメントページのURLが自動的に入力されているので、別途どの画面のフィードバックかを入力する必要は無いです。

Feedback

フィードバックの種類を選択します。最初から想定されるケースが用意されているので、フィードバックも簡単です。

  • Kudos
  • Typo, grammar, or spelling issue
  • Broken link
  • Inaccurate content
  • Other

一番上の「Kudos」が面白いですね。フィードバックって基本的にはダメ出しのイメージが強いですが、「おま、このドキュメントめちゃくちゃわかりやすいやんけ!最高!」という賞賛の声も送ることができるってのが素晴らしい。

その他、よくあるスペルミスや壊れたリンク、不正確な表現などが用意されています。該当しない場合は、Otherで。

自由入力欄

「How can we make the documentation better?」「What are you trying to do?」の自由入力欄も用意されているので、ここにフィードバック内容の詳細を記載します。恐らくは日本語でも受け付けてくれると思うのですが、受領側の負荷が高く後回しにされる可能性が高いので、頑張って英語で書きましょう。

Contact Information(Optional)

フィードバック先とやり取りが必要な場合、任意でメールアドレスを設定できます。自分は昔、Cloud MapにドキュメントヒストリーにRSSフィード場がなかった時にそのフィードバックを送ったら、担当の方から「だよな!あったほうが便利だよな!設置するぜ!」というアツいメッセージがきて嬉しかったので、そういうったやり取りがしたければ、メールアドレスを入れておくことをオススメします。

中の人と直接やり取りができるのは、やっぱり楽しいですよ。

Security Check

人間存在確認のための文字入力です。

以上、入力したら、さくっと「Submit Feedback」してみましょう。お疲れさまでした。

手間も殆どかからないので気軽にフィードバックしてみよう!

自分は今まで累計10回ぐらいドキュメントフィードバックしているのと、直近re:Invent期間中も3回ぐらいやりました。特に新サービス系は、まだ整備が追いついていないのかドキュメントが整っていないことも多いです。

Contact Informationにメールアドレス書いている場合、早い場合で1〜2日ぐらいで「対応したぜ。ありがとな!」っていう感じの返信があったりするので、こういうのも嬉しいですね。AWSに長く関わっていく中、こういった貢献方法もあるので、気軽にフィードバック送ってみると良いと思います。

それでは、今日はこのへんで。濱田(@hamako9999)でした。