LINE Planetドキュメントサイト改善のお知らせ
こんにちは、LINE Planetプロジェクトのテクニカルライターのハ・ソンチャンです。今年初めにLINE Planetのドキュメントサイトを新しく立ち上げ、より良い構成とUIを提供するだけでなく、これまで英語のみに対応していたものを英語と韓国語の2つの言語にも対応するようにしました。その後も、より良いユーザーエクスペリエンスを提供するために努力を続けています。
ここでは、最近リリースされたPlanetKit 5.2およびWebPlanetKit 5.2までのLINE Planetドキュメントサイトの改善点をご紹介します。ここでは、改善の核となる情報アーキテクチャの改善、開発者体験の向上、検索機能の最適化を中心に説明します。
情報アーキテクチャの改善
従来は、クライアント開発者向けのコンテンツとサーバー開発者向けのコンテンツの領域区分が明確でなく、ユーザーは欲しい情報を探すのに苦労していました。これらの問題を解決し、ドキュメントサイトの構造をより直感的にするために、以下のようにユーザータイプ別のワークフローに合わせてコンテンツを再構成し、関連するトピックをグループ化しました。
ドキュメントサイトの上位レベルの構造は、次のとおりです。
| トップカテゴリー | 説明 | ドキュメントバージョン区分 |
|---|---|---|
| 概要 | LINE Planetの主な特徴、全機能一覧、主な用語の定義などを含む概要をご紹介します。 | バージョン区分なし* |
| はじめる | LINE Planetとの連携プロセスを開始するための領域で、開発環境設定、サンプルアプリケーションクライアント及びサーバーの使い方について説明します。 | バージョン区分なし |
| SDK | アプリケーションクライアントを直接実装するためのガイドと参考資料をクライアントプラットフォーム別に分けて提供します（Android、iOS/macOS、Windows、Web）。 | プラットフォームごとにSDKバージョン別のドキュメントを提供 |
| サーバーAPI | サーバー側の連携のためのガイドと参考資料を提供します。 | バージョン区分なし |
| ヘルプ | よくある質問への回答、トラブルシューティング資料、連絡先情報など、一般的な問題を解決するためのリソースを提供しています。 | バージョン区分なし |
* バージョン区分のないドキュメントは、最新の情報のみを提供します。
開発者体験の向上
これまでは、すべてのプラットフォームに共通のドキュメントセットを提供し、複数のプラットフォームで同じ機能を持つAPIを示すために共通のキーワードを使用していました。例えば、実際のAPIネーミングパターンはプラットフォームによって異なりますが、すべてのプラットフォームのイベントコールバックを表現するためにキーワード「evt*」（例えば、evtConnectedとevtDisconnected）を使用していました。このようなドキュメント作成方法のため、APIリファレンスやコードと共にドキュメントを見て理解することが困難でした。
この問題を解決するために、次のように開発者体験をより効率化するための作業を行いました。
- プラットフォームとバージョン別にドキュメントを分割
- 「SDK」カテゴリのドキュメントをクライアントプラットフォーム別に分割しました。
- 各クライアントプラットフォームのドキュメントのバージョンは、そのプラットフォームSDKのリリースバージョンに相当します。
- 実際のAPIを反映するようにドキュメントを更新
- 実際のAPI名を反映するため、ドキュメント全体の説明及び図を更新しました。
- 注：この変更はPlanetKit 5.2およびWebPlanetKit 5.2のドキュメントから適用されます。
- より多くのコードサンプルを提供
- プラットフォームとバージョンごとにドキュメントを提供し、そのプラットフォームとバージョンのコードサンプルを追加できるようになりました。
- これは継続的な作業であり、顧客がサービスを実装する際に役立つようにコードサンプルを追加し続ける予定です。
以下の図のように、左側のサイドバーのドロップダウンメニューからクライアントプラットフォームとSDKバージョンを選択できます。
検索機能の最適化
クライアント側の実装のためのドキュメントがプラットフォーム別、バージョン別に提供され、コンテンツの量も増えました。したがって、従来のようにすべてのドキュメントに対して特定のキーワードで検索した結果を表示すると、検索結果が多すぎて必要な情報を見つけるのが難しい可能性があります。
この問題を解決するために、次のように状況に応じた方法で検索が動作するようにしました。（いずれの場合も、現在選択されている言語に応じて検索が行われます）
- 「SDK」カテゴリのドキュメントを表示した状態で検索すると、残りのカテゴリの全体と「SDK」カテゴリのうち、現在のプラットフォームとバージョンのドキュメントのみを対象に検索が行われます。
- 「SDK」以外のカテゴリのドキュメントを表示した状態で検索すると、ドキュメント全体で検索が行われます。
このような状況に合わせた検索機能により、必要な情報をより簡単かつ効率的に検索できると期待しています。
参考までに検索機能の使い方は次のとおりです。まず、右上の検索ボックスにキーワードを入力すると、検索結果が表示されます。
より多くの検索結果を見るには、下にスクロールして下部の「検索結果をすべて表示する」をクリックしてください。
すると、すべての検索結果を表示するページが表示され、スクロールしてより多くの検索結果を確認できます。さらに、以下に表示した部分のドロップダウンメニューから検索したいクライアントプラットフォームのドキュメントのバージョンを選択して新たに検索することもできます。
おわりに
ここまで、LINE Planetのドキュメントサイトに適用された改善点をご紹介しました。上記の3つの側面に着目することで、サイト全体のユーザビリティが大幅に向上したと思います。今後は、新規ユーザー向けのオンボーディングコンテンツの追加や、LINE Planetをより効率的に活用できるようにコード例を拡張するなど、さらなる改善に取り組んでいきたいと思います。