よくある質問の書き方
よくある質問の種類
よくある質問は、以下のパターンで作成します。
単一の質問に答える記事の構成
「よくある質問」の基本形。基本的にはこの形式で作成します。
1.質問（タイトル）
文頭に Q. をつけ、ユーザーからの質問のように 「XXできる？」「XXするには？」 という形（常体）で記載します。
文末が「？」で終わらない場合は、Headingの見出しの書き方に則り、句点は省略します。
例外的に口語体で表現しますが、「 」は使用しません。
2.回答（見出し）
文頭にA. をつけ、質問に対する回答を端的にまとめます。
見出し1のスタイルを適用します。
例外的に口語体で表現しますが、「 」は使用しません。
Headingの見出しの書き方に則り、句点は省略します。
3.説明
質問に対して、回答を詳細に説明します。
本文のスタイルを適用します。
4.関連リンク
ヘルプセンターの中に操作手順などの詳細ページがある場合（同内容のページがヘルプセンター内に複数あると、管理が煩雑になり、最新の情報に保ちにくいため）や、他のWebサイトに参照記事がある場合はリンクを設置します。
関連コンテンツのスタイルを適用します。
5.操作手順
参照先のヘルプページがないときは、記事中に手順を書きます。
手順が複数の工程に分かれる場合は、見出しで工程ごとに分割し、操作手順記事と同じルールで記載します。
見出し2と本文のスタイルを適用します。
ライティングパターン
質問と回答のライティングパターンをまとめました。
内容に応じて、文末の表現などをアレンジしても構いません。
| コンテキスト | 1.質問（タイトル） | 2.回答（見出し1） |
|---|---|---|
| こういうことはできるのか？ | Q. XXXできる？ | A. はい、XXXXできます／A. いいえ、XXXXXはできません |
| メイン操作ではないイレギュラーな操作 | Q. XXXするには？ | A. XXXXXを設定します |
| 仕様の背景の説明 | Q. XXXはなぜ？ | A. XXXXXためです |
記載例
-
Q. SmartHR基本機能に招待前の従業員を、評価対象者や評価者として追加できますか？
A. 従業員情報が登録されていれば、SmartHR基本機能の「招待」前でも追加できます別タブで開く -
Q. サーベイを「匿名で扱う」とどうなる？
A. 回答から個人を特定できなくなります。また、回答者が3名以下の部署・雇用形態がある場合、回答データの表示や分析に制限があります別タブで開く
いくつかの質問をまとめた記事の構成
1つの機能やテーマについて、よくある質問をまとめたいとき。（質問が増えてきたら個別の記事に分割することを検討しましょう。） 一問一答形式など、質問と回答の情報量が少ない場合にも使用して構いません。
1.タイトル
質問の共通テーマを明記のうえ、「よくある質問」をタイトルに含めます。
- XXXXに関するよくある質問
- XXXX向けよくある質問
2.質問
単一の質問と対処方法を伝える場合のタイトルと同様。
見出し1のスタイルを適用します。
3.回答
単一の質問と対処方法を伝える場合の見出しと同様。
見出し2のスタイルを適用します。
4.説明
単一の質問、またはエラーの原因と対処方法を伝える場合の説明と同様。
本文のスタイルを適用します。
記載例
よくある質問に含めるべきでない内容
よくある質問のセクションには、機能の主要な用語の定義や複雑な操作手順を混在させないようにしましょう。
よくある質問は、質問と回答を扱う場所です。
よくある質問に長文の用語定義や複雑な操作手順が混在すると、以下の問題が生じます。
- 質問の粒度がバラバラになる：質問への回答と、用語の定義や操作手順の説明では情報の種類や量が異なり、よくある質問としての一貫性が崩れます。
- 更新漏れが起きやすくなる：用語の定義や操作手順が変わった際に、本来の掲載ページとよくある質問のページの両方を更新する必要が生じます。
- よくある質問がなんでも置き場化する：よくある質問の役割が不明確になり、どこに何を書くかの判断基準が曖昧になります。
用語の定義は概要ページ、操作手順は操作手順ページにそれぞれ記載し、よくある質問からはリンクで誘導しましょう。