ヘルプページの構成

ヘルプページの構成

ヘルプページは、以下の要素で構成されています。

  1. タイトル(必須)
  2. リード
  3. 見出し(必須)
  4. 本文(必須)
  5. 画像
  6. 囲み

要素ごとの考え方

それぞれの要素ごとの役割について説明します。

要素ごとの具体的なライティングパターンは、ヘルプページのタイプ別のライティングを参照してください。

1. タイトル

どんな内容が書かれているかを想起できる表現をして、ユーザーが「読みたい情報がどこに書かれているか」を理解できるようにします。
ヘルプセンターを訪問したユーザーが、操作手順やトラブルシューティング、リファレンスを探していることを念頭において考えます。

インデックスに並んだときの一覧性を意識し、タイトルのライティングには規則性を持たせます。

2. リード

ユーザーがページの内容を理解するためのメンタルモデルを構築しやすいよう、このページで書かれている内容の全体感を説明します。

3. 見出し

本文のアウトラインを把握できる表現をします。
見出しはページ全体の目次としても機能するので、「どんな内容」を「どういう順序」で「どれくらいの粒度」で書かれているかを把握する助けもします。

ヘルプページの見出しは、見出し1〜5まであります。
本文で記載する内容を見出しを使って構造化します。ヘルプページの構成を考えるときには、まず見出しの設計をして、情報のボリューム、伝える単位を切り分けることからはじめると良いです。

4. 本文

本文もなるべく簡潔に、一文一義「1つの文に1つの事柄を書く」ようにします。

ただし、ヘルプページで記載する内容は、ある条件下の挙動を説明するなど、情報が込み入っているケースも少なくありません。
情報を補う修飾節が必要な場合は、情報のチャンク(ぱっと見たときに"意味的な塊"を感じる単位)を意識して読点を使用しましょう。

5. 画像

文章での説明が困難な場合、注釈を加えた画面キャプチャを使います。

画面キャプチャ・加工のガイドライン(作成中)

6. 囲み

本文で説明する主軸となる流れから、脱線する情報は囲みとして提供します。

ヘルプページでは、囲みに4つのスタイルを用意しています。
囲みの中身は本文を配置します。Tipsに限って、見出しを設置しても構いません。

Tips

ページで説明している内容に加えて、知っておくとユーザーにメリットがある情報を紹介します。

tips.png

注意点

注意を促したい場合に使います。
この情報を理解しないとユーザーが求めている情報を得られなかったり、意図しない結果に繋がったりする可能性のある、重要度の高い情報を記載します。

alert.png

関連コンテンツ

ページで説明している内容に関連するリンクを紹介するときに使います。

related.png

関連用語

用語ページで関連用語を紹介するときに使います。

words.png