AWS SDK for JavaScript v3 の新しいドキュメント(開発者プレビュー)が公開されていました

2023.05.19

こんにちは、CX事業本部 Delivery部の若槻です。

いつものように AWS SDK for JavaScript v3 のサービス仕様を確認するためにドキュメントを見てみると、何やら見慣れないメッセージが大きく表示されていました。

どうやら、新しいドキュメントが開発者プレビューとして公開されたようです。

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

(日本語訳) AWS SDK for JavaScript v3 の新しい API ドキュメントの開発者プレビューを発表できることを嬉しく思います。ランディング ページの指示に従ってフィードバックをお送りください。

メッセージ中のリンクを開いてみると、新しいドキュメントを開けました。

今回は、こちらの AWS SDK for JavaScript v3 の新しいドキュメントを触ってみて、どのような改善点があるのか確認してみました。

改善点

デザインの統一

まず目を引いたのが UI のデザインです。従来のドキュメントは一見して AWS の公式ドキュメントであるかどうか分かりにくいデザインでしたが、新しいドキュメントでは AWS のブランドデザインに則ったデザインとなっています。

プロダクトのトップページやドキュメントページと見比べても、ヘッダーや配色など全体的に既存のページのデザインに統一されていることが分かります。

一見して AWS の公式ドキュメントであるデザインであることが分かるのは安心感があります。

グローバルメニュー

従来のドキュメントではグローバルメニューが無く、あるサービスのページ内から別のサービスのページへ遷移するための導線がありませんでした。

新しいドキュメントではグローバルメニューが追加され、ドキュメント内でのページ遷移をしやすくなっています。

サービス検索機能

従来のドキュメントでも検索機能はあるにはあったのですが、サジェストはされず、またそもそも検索メニューの場所が分かりづらいという問題がありました。

新しいドキュメントではサービス検索機能が強化され、サービスのクライアントやコマンドをサジェスト付きで検索できるようになりました。

一覧の中のリンクからコマンドの詳細ページに遷移するのですが、一覧内にサマリーが表示されているのも嬉しいですね。

ページ遷移の高速化

新しいドキュメントでは、サービスページを遷移する際の表示速度が従来のドキュメントと比べて高速化されていました。(一方でコマンドページの表示は従来どおり少し時間が掛かります)

ドキュメントで利用されている技術周りを確認すると、新旧ともに、配信は Amazon CloudFront、フレームワークは Next.js が使われている点は変わらないようです。

一方で、ドキュメントを初回表示する際の速度は従来のドキュメントの方が若干早いですね。

新しいドキュメントでは、SPA の範囲が従来に比べて大きくなる代わりに、ドキュメント内でのページ遷移を高速化しているようです。

おわりに

AWS SDK for JavaScript v3 の新しいドキュメント(開発者プレビュー)の改善点を確認してみました。

すごく使いやすくて私はすぐに気に入りました。皆さんも是非試してみてください。また、フィードバックを送るためのリンクがドキュメント内に用意されているので、気になる点があればぜひフィードバックを送ってみてください。

以上