概要の書き方

基本的な考え方

概要を説明するページでは、アプリケーションを利用するための前提を伝えます。ユーザーが機能を利用する場面をイメージでき、操作手順やよくある質問のヘルプページの理解を助ける状態を目指してください。

作成基準

操作手順の1セクション分の文章量では概要を伝えきれない場合に、概要に関するヘルプページを作成します。

構成

概要に関するヘルプページは、以下のセクションを組み合わせて構成します。

セクションごとの書き方

各セクションの内容をどのように伝えるかをまとめています。

1. 機能名（タイトル）

アプリケーション上の機能名を記載し、「最初に読むべき、機能の全体像を把握できるヘルプページ」であることを伝えます。

「XXとは」 の形で記載します。
機能名は、アプリケーションの画面とヘルプページを紐づけられるように指定します。なるべく省略せず、コンテキストを持たないユーザーでもヘルプページを探せるようにしてください。

• OK例：部署マスターの履歴管理機能とは
• NG例：履歴管理機能とは

2. 機能の動作（リード文）

アプリケーション上での操作と動作を端的に伝えます。

「XXでは、XXができます」 の形で、1〜2文で記載します。
アプリケーション上の言葉で、機能の動作を簡潔に説明します。

機能の動作は、「XXの登録」「XXの削除」といった形が基本です。

3. ユーザーができること（リード文）

機能によってできるようになること、便利なことをユーザー目線で伝え、機能のよさを理解するのを助けます。

機能が与えるメリットや、機能によって行動がどう変わるのかを、1〜2文で記載します。
アプリケーション上の言葉ではなく、ユーザー目線の言葉を使うように心がけてください。

• OK例：XXやXXを管理する手間を省けます。
• NG例：XXやXXを操作できます。

4. 利用できるプラン（見出し＋本文）

利用できるプランを記載し、対象のユーザーを限定します。

見出しは 「利用できるプラン」 とし、利用できるプランを箇条書きで記載します。

プランによって機能の一部が利用できない場合は、プランと機能を軸とした表を使用します。

5. 事前知識（見出し＋本文）

アプリケーション独自の用語や考え方を説明します。操作手順やよくある質問を読んだ際の理解を助けます。

見出しは 「XXとは」 の形で記載します。

説明すべき用語が複数ある場合は、見出しも複数用意します。

6. 利用する場面（見出し＋本文）

「2. 機能の動作」で挙げた機能を使う場面を記載し、具体的な活用方法を伝えます。

ユーザーにとって利用する場面が明確な場合や、「機能の動作」に焦点を当てたい場合は、「7. 機能の動作の列挙」を記載します。「6. 利用する場面」は必要ありません。

見出しは 「利用する場面」 とします。

「利用する場面」の見出しの下位に、利用する場面ごとに見出しを設定します。

7. 機能の動作の列挙（見出し＋本文）

「2. 機能の動作」で説明した動作を列挙して説明し、機能の全体像を把握するのを助けます。

ユーザーにとって利用する場面が明確でない場合や、「ユーザーができること」に焦点を当てたい場合は、「6. 利用する場面」を記載します。「7. 機能の動作の列挙」は必要ありません。

見出しは 「機能一覧」 とします。

「機能一覧」の見出しの下位に、機能の動作ごとに見出しを設定します。

8. 具体的な情報の案内（関連リンク）

機能を利用するために必要な、具体的な情報を伝えます。

権限設定や操作手順へのリンクなどを記載します。

ライティングパターン

内容に応じて、表現をアレンジしても構いません。

「機能の動作の列挙」を記載するライティングパターン

「利用する場面」を記載するライティングパターン