ポータル構築のベストプラクティス

ポータルを構築する際は、以下のセクションに示すベストプラクティスを適用することをおすすめします。

対象ユーザーの関心を引く

対象ユーザーに視覚的に訴えかけ、もっと知りたいと思わせるようなコンテンツを追加します。ポータルの一部はログインしなくても閲覧できるようにします。API 利用者がすぐに API を使用してアプリの開発を始められるように、セルフサービスの登録を提供します。

ユーザーが API を試せるようにする

OpenAPI 仕様からインタラクティブな API ドキュメントを自動生成します。ユーザーはこのページで次のことができます。

API について学ぶ
API にライブリクエストを送信する
API から返されたライブレスポンスを見る

詳細については、API の公開をご覧ください。

レベルに応じた学習プログラムを用意する

対象ユーザーの経験レベルに応じて、関連する使用事例やチュートリアルを提供します。単純な curl コマンドなどの例を使って具体的に説明するか、より詳細な手順を段階を追って示します。

検索エンジン最適化（SEO）を実施する

コンテンツを確実に検索可能にします。SEO に投資して検索結果のランキングを上昇させ、ユーザーがポータルのコンテンツを見つけられるようにします。

検索エンジン最適化

コンテンツの構造を決めるときは次のベストプラクティスを使用します。詳細と Google による追加ガイドラインについては、Google 検索エンジン最適化（SEO）スターターガイドをご覧ください。

ベストプラクティス	説明	利点
ユーザーフレンドリーな URL を作成する	無意味な文字の羅列ではなく、意味のわかる URL を作成します。ポータルにページを追加するときに、ユーザーフレンドリーなページ URL を定義します。	人間が読める形式でページの目的を伝えます。ページ URL に対するキーワードの完全一致または部分一致により、検索ランキングが上昇します。通常、URL は検索結果に表示されます。
ポータル名をわかりやすいものにする	ポータルを管理するときに、ポータルに独特でわかりやすい名前を付けます。この名前は、ポータルのホームページ（`index`）の `<title>` タグを設定するために使用されます。	タイトルに対するキーワードの完全一致または部分一致により、検索ランキングが上昇します。通常、ページタイトルの内容は検索結果の最初の行に表示されます。
サイト内を移動しやすくする	ナビゲーションを設定するときに、論理的に理解できるナビゲーション構造を定義します。	ユーザーが現在ポータル上のどこにいるのか把握できます。ユーザーが必要なコンテンツをすばやく簡単に見つけられるようになります。
キーワードフレーズをうまく組み合わせてコンテンツ全体に配置する	コンテンツ内の適切で意味のある箇所にキーワードを含めます。あるキーワード文字列がページで顕著に使用されていると、検索結果のページランキングが上昇する可能性があります。ユーザーがポータルのコンテンツを検索するときに使用する可能性があるキーワード文字列を予測してみます。ただし、「キーワードスタッフィング」にならないように注意します。つまり、検索ランキングを上昇させるためだけにキーワードを過剰に使用することは避けます。キーワードスタッフィングを行っていると判断されたサイトは、検索エンジンによってペナルティが課される場合があります。	ユーザーが関連する検索を行ったときにヒットする可能性が高くなります。

デベロッパーコミュニティを構築する

ソーシャルメディアを利用し、Facebook や Twitter などの一般的なソーシャルチャネルを通じて API コミュニティを振興します。ブログの投稿やフォーラムの開催により、API コミュニティに関わるデベロッパーの間のコミュニケーションやインタラクションを促進します。