• TOP
  • DataStax
  • 新しくなったDataStax製品ドキュメントサイトをご紹介します
新しくなったDataStax製品ドキュメントサイトをご紹介します
2022.09.14 DataStax翻訳記事

はじめに

DataStax製品ドキュメントチームは、Astra DBやAstra Portalのストリーミングなどの、DataStaxクラウド製品を使用する開発者に、新しいエクスペリエンスを提供すべく力を注いできました。数か月間にわたり、ユーザーへのインタビュー、テクニカルコミュニケーション業界他社のドキュメントサイトの調査を行い、そしてエクスペリエンスデザイン、ウェブ、ブランディングといった各チームとの協働を経て、ドキュメントサイトにいくつかの新機能を導入しました。

  • カード型デザインのランディングページ
  • ダークモード
  • フィードバックフォーム
  • ガイド付きコードエクスペリエンス

チームは、ドキュメントサイトでのエクスペリエンスを向上させるために、機能をひとつひとつ調査していきました。

Sam Ramjiは、次のように述べています。

「優れたドキュメントとは、ユーザーのことを、どれほど思っているか伝えることなのです。新しいドキュメントサイトは、考え抜かれたデザインになっており、視覚的にエレガントで、使いやすくなっています。 卓越したドキュメントは、ユーザーの立場で書かれており、読み進めたくなるものです。 優れたドキュメントは、ユーザーの問題を、単に掘り下げる手助けをするだけでなく、システムの機能についてどう考えるべきかというすじみちを提供します。新しいサイトでは、左側にあるナビゲーションとメインキャンバスのカードを使ってこれらを示しています。」

カード型デザインのランディングページ

ユーザーが探している情報にたどり着けるようデザインされた新しいランディングページを開発しました。

カード型デザインのレイアウトを使うことで、開発者や企業が業務を遂行する上で必要な情報を、ハイライトすることができるようになりました。私たちは、お客様の作業負担を減らし、効率を向上させることを重要視しています。これらのカードは、ユーザーからのフィードバック、Astra Portalへの統合、機能の追加などに応じて、進化を続けていきます。また、各カードには、製品ドキュメント内外のリソースへのリンクを含めることができます。

新しいランディングページを開発するために、私たちはユーザーへのインタビューを行い、DataStax エクスペリエンス デザイン チームの調査結果をレビューしました。また、開発者やお客様である企業にとって、最も役立つものは何であるのか判断するために、製品だけでなく、StargateK8sandraといったオープンソースプロジェクトを査定しました。

新しいカードに加え、左側のナビゲーションから特定の製品のドキュメントに素早くアクセスできるようになりました。新しい製品やツールの多くを優先的に表示するようにしました。すべての製品ドキュメントへのリンクは、「All documentation links (すべてのドキュメントへのリンク) 」ページからアクセスすることができます。

ダークモード

開発者はなぜダークモードが好きなのか?いくつかの理由があります

  • 画面を見ている時間が長いほど、目の休息が必要になります。
  • 視覚障害のある人は、ダークモードの方が視覚をうまく処理することができます。
  • ダークモードは、睡眠パターンに悪影響を与えるブルーライトを低減します。

私たちは常に開発者のことを考えています! また開発者向けのドキュメントがより使いやすいものにしたいと考えており、ダークモードは優先度の高い選択肢の1つです。

ご意見・ご感想フォーム

私たちはユーザーのことを考えており、彼らの声をすごく聞きたいと思っています。そこで、ドキュメントに関するフィードバックを簡単に得られるようフォームを作成しました。各ページの下にあるこのフォームを使って、知りたいことがなにで、うまくいっていないことはなにかお知らせください。

ユーザーの皆様からいただいたご意見は、今後の継続的な改善に役立たせていただきます。誤字・脱字を見つけたとき、またよりよい仕事をするためのアイデアをお持ちの方は、フォームで共有してください。私たちチームは、定期的にフィードバックを確認し反映します。

お名前とEメールアドレスは必須入力ではありませんが、以下の理由から、お知らせいただけますと助かります。

  • ご提案いただいた内容について、ご連絡して、明確にすることができます。
  • ご提案いただいた内容について、変更した際には、その旨お知らせすることができます。

フィードバックをいただくことで、より良いドキュメント、またより良いドキュメント体験をご提供することができます

ガイド付きコード体験

私たちのガイド付きコード体験(GCX:Guided Code eXperience)は、開発者にインストラクションとコードサンプルを並べて提供します。開発者がインストラクションに沿ってある手順を選択すると、コード内の対応する行がハイライトされ、開発者にインストラクションとコードをすばやくナビゲートできます。

JavaドライバでAstra DBに接続するためのGCXを見ると、左側に利用可能なGCXデモのナビゲーションメニューが表示されます。開発者のトレンドに基づいて、私たちはまずJavaとPythonのGCXを作成することから始めました。今後、皆様からのフィードバックをもとに、さらにGCXを作成していく予定です。

次のステップは?

Sam Ramjiは、DataStax製品ドキュメントチームに、開発者や企業のために新しいコンテンツを作成し、エクスペリエンスを向上し続けるよう促してきました。

『ユーザーのニーズに寄り添い、そのバイタリティあふれる力を更に活用していきましょう。』

私たちは、ビデオ、API機能を試すなど、新しい体験を模索しています。アイデアをお持ちの方は、docs@datastax.comまで、ぜひお聞かせください。

原文:A New Product Documentation Experience

関連記事