よくある質問の書き方

よくある質問の種類

よくある質問は、以下のパターンで作成します。

単一の質問に答える記事の構成

「よくある質問」の基本形。基本的にはこの形式で作成します。

  1. 質問(タイトル)
  2. 回答(見出し)
  3. 説明
  4. 関連リンク
  5. 操作手順

1.質問(タイトル)

文頭に Q. をつけ、ユーザーからの質問のような表現をします。

例外的に口語体で表現しますが、「 」は使用しません。
Headingの見出しの書き方に則り、句点は省略します。

2.回答(見出し)

文頭にA. をつけ、質問に対する回答を端的にまとめます。

見出し1のスタイルを適用します。
例外的に口語体で表現しますが、「 」は使用しません。
Headingの見出しの書き方に則り、句点は省略します。

3.説明

質問に対して、回答を詳細に説明します。

本文のスタイルを適用します。

4.関連リンク

ヘルプセンターの中に操作手順などの詳細ページがある場合(同内容のページがヘルプセンター内に複数あると、管理が煩雑になり、最新の情報に保ちにくいため)や、他のWebサイトに参照記事がある場合はリンクを設置します。

関連コンテンツのスタイルを適用します。

5.操作手順

参照先のヘルプページがないときは、記事中に手順を書きます。
手順が複数の工程に分かれる場合は、見出しで工程ごとに分割し、操作手順記事と同じルールで記載します。

見出し2と本文のスタイルを適用します。

ライティングパターン

質問と回答のライティングパターンをまとめました。
内容に応じて、文末の表現などをアレンジしても構いません。

コンテキスト1.質問(タイトル)2.回答(見出し1)
こういうことはできるのか?Q. XXXできる?A. はい、XXXXできます/A. いいえ、XXXXXはできません
メイン操作ではないイレギュラーな操作Q. XXXするには?A. XXXXXを設定します

記載例

エラーの原因と対処方法を伝える記事の構成

  1. 質問(タイトル)
  2. リード
  3. 原因(見出し)
  4. 説明
  5. 対処方法

1.質問(タイトル)

文頭に Q. をつけ、エラーの状態を書きます。読みづらい長文にならない限り、基本的にエラーメッセージをそのまま記載します。

プロダクトのHeadingルールに則り、句点は省略します。
例外的に口語体で表現しますが、「 」は使用しません。

2.リード

エラーがどの画面で、どういったときに起きるかなどを簡潔に書きます。タイトルでエラーメッセージを省略した場合には、必ずエラーメッセージを記載します。

本文のスタイルを適用します。

3.原因(見出し)

文頭にA. をつけ、原因を簡潔に記載します。

見出し1のスタイルを適用します。
例外的に口語体で表現しますが、「 」は使用しません。
Headingの見出しの書き方に則り、句点は省略します。

4.説明

原因を詳細に説明します。どのような条件で操作をするとそのエラーが起こるのかを説明します。

本文のスタイルを適用します。

5.対処方法

対処方法を書きます。
手順が複数の工程に分かれる場合は、見出しで工程ごとに分割し、操作手順記事と同じルールで記載します。

見出し2と本文のスタイルを適用します。

記載例

いくつかの質問をまとめた記事の構成

1つの機能やテーマについて、よくある質問をまとめたいとき。(質問が増えてきたら個別の記事に分割することを検討しましょう。) 一問一答形式など、質問と回答の情報量が少ない場合にも使用して構いません。

  1. タイトル
  2. 質問
  3. 回答
  4. 説明

1.タイトル

質問の共通テーマを明記のうえ、「よくある質問」をタイトルに含めます。

  • XXXXに関するよくある質問
  • XXXX向けよくある質問

2.質問,

単一の質問、またはエラーの原因と対処方法を伝える場合のタイトルと同様。

見出し1のスタイルを適用します。

3.回答

単一の質問、またはエラーの原因と対処方法を伝える場合の見出しと同様。

見出し2のスタイルを適用します。

4.説明

単一の質問、またはエラーの原因と対処方法を伝える場合の説明と同様。

本文のスタイルを適用します。

記載例