このページには、Google Season of Docs で承認されたテクニカル ライティング プロジェクトの詳細が掲載されています。
プロジェクトの概要
- オープンソース組織:
- Hydra エコシステムのドキュメント
- テクニカル ライター:
- AwesomeChap
- プロジェクト名:
- ドキュメント サイトの UX の改善
- プロジェクト期間:
- 標準期間（3 か月）
プロジェクトの説明
ドキュメント シーズンのアイデアページに投稿された「ドキュメント サイトの UX の改善」というアイデアに興味を持ち、ご連絡いたしました。私は、React デベロッパー、デザイナー、そして熱心なテクニカル ライターです。また、大規模な学際的なチームで働いた経験もあります。開発以外にも、TheStartup などの出版物に技術的なブログを書いています。私のブログをご覧になるには、https://medium.com/@jatin15011999 にアクセスしてください。私の詳細については、ウェブサイト（www.jatinkumar.tech）をご覧ください。私の経験とスキルセットは、このアイデアに最適であると確信しています。
MERN スタックに関する 2 年以上の経験があり、目を引く UI と優れた UX を備えた堅牢なインターフェースを非常に迅速に構築できます。React と Node.js に精通しており、コードと創造性を組み合わせるのが大好きです。これまでの経験では、さまざまなフロントエンド レイアウトを開発し、さまざまな問題を解決してきました。UI/UX のデザイナーである私は、優れたウェブサイトの UI/UX が訪問者にどれほど大きな影響を与えるかをよく知っています。優れたコンテンツがウェブサイトにどれだけあっても、ユーザーに優れたユーザー エクスペリエンスを提供できない限り、意味がありません。お客様のウェブサイトに再度アクセスする意欲が低下します。優れた UI/UX は、色の変更や邪魔にならないアニメーションの追加など、シンプルなものでも構いません。しかし、そうしたシンプルな変更を考えるには、適切な組み合わせを見つけるまで何百もの試行が必要になります。私はその点において十分な経験があり、非常にエレガントで効率的な方法で実現できると考えています。
Hydra の現在のウェブサイトは詳しく調べましたが、このサイトには重大な問題があるということに唯一同意しました。あなたのアイデアに説明されているように、サイドバー / トップバーをウェブサイトに追加することで、簡単に整理できます。しかし、現在のサイトを詳しく見てみると、すでに上部にナビゲーション バーがあるので、Topbar はオプションではなく、Sidebar の方が適しているように思えます。また、アイデア ページで説明されているように、一部のドキュメントは、ナビゲーションを容易にするために [ホーム] セクションにリンクする必要があります。これらの制約をすべて考慮して、プロトタイプを設計しました。プロトタイプは http://hydra-doc.herokuapp.com/ でご覧いただけます。このプロトタイプは完全にレスポンシブで、他のさまざまなドキュメント サイトからヒントを得ています。ノートパソコンなどの大画面で開いたときとはまったく異なるユーザー エクスペリエンスを提供します。このプロトタイプを見たことがある方は、ランディング ページ（こちらでもある概要ページ）に [詳細] と [API ドキュメント] の 2 つのボタンがあるのを見たことがあるかもしれません。これで、API ドキュメントがメインのウェブページにリンクされ、問題の 1 つが解決したようです。しかし、ナビゲーションはどうでしょうか？心配しないでください。このサイトでは、その点についても非常に洗練されたソリューションを提供しています。[詳細] ボタンを押すと、ウェブサイトの概要セクションまでスクロールされます。このセクションを操作すると、コンテンツの視認性とユーザー エクスペリエンスを損なうことなく、ナビゲーションの問題をエレガントに解決できることを実感できます。画面が狭い場合はサイドバーが非表示になり、コンテンツが適切なスペースを占有します。画面が広く、コンテンツとサイドバーの両方が共存できる場合は、サイドバーも必要なスペースを占有します。また、ユーザーが別のページに移動したい場合も、画面上部のナビゲーション バーで特定のタイトルをクリックするだけで簡単に移動できます。邪魔にならない滑らかなアニメーションは、ユーザー インタラクションを向上させ、ウェブサイトの UX をさらに高めてくれます。
ナビゲーションだけでなく、コンテンツの流れも問題であり、この問題の解決には時間が必要だと考えています。時間の制約により、上記のプロトタイプに組み込むことができませんでした。ですが、現在のコンテンツ フローを改善するためのアイデアはたくさんあります。時間が残っていれば、現在の作成者がウェブサイトでブログやガイドを作成する方法を改善することもできます。Medium のようなコンテンツ管理システムがこの問題を解決する可能性は十分にあると思います。作成すれば、medium でブログを書いてから medium.com にリダイレクトする必要がなくなります。これは、ユーザーがブログとメインサイトをより頻繁に移動する必要がある場合にかなり煩わしくなります。ユーザー自身でブログをホストすることができ、ユーザーはブログに簡単にアクセスできます。また、媒体と同等の CMS があることに加えて、作成者は作成したブログやガイドを非常に簡単に編集できます。
私のアイデアが気に入っていただければ幸いです。私の経験とスキルセットは、このアイデアの実現に最適なものであると自負しております。