この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。
はじめに
こんにちは。モバイルアプリの運用を担当しているkobayashiです。 今日、ちょうどモバイルアプリのエンドユーザー向けFAQの添削をしており、そういえば自分はこんなことを意識して書いているなと気づいたことをまとめたいと思います。
気をつけていること５つ
1. 探しやすいタイトルをつける
エンドユーザーがFAQで最初に見るのはタイトルです。並んでいるタイトルの中から知りたいことをすぐ探せることが重要です。そのために、以下２点を意識しています。
①キーワードの設定 私の場合は、まず、キーワードを含んだタイトルを仮で置いてからFAQ本文を書き始めます。FAQ本文を書き終わったら、タイトルと本文が一致しているか、ユーザーが探す時に迷いそうでないかをチェックします。
②疑問にフォーカスする 外せないキーワードが多い場合や実際にその内容の問い合わせが多い場合は、「〜したい」系のタイトルや「○○できない」系のタイトルを使うことがあります。
例えば、アカウントの登録がうまくいかない場合の解決方法を示すFAQを書くとします。キーワードとしては「アカウントの登録」なので「アカウントの登録について」で誤りではないですが、この場合「アカウントの登録に失敗する」の方が適切です。「アカウントの登録について」だとアカウントの登録方法やアカウントの登録で受けられるサービスなど様々な疑問を持った人も対象になる可能性があります。できるだけ曖昧さを排除すると良いです。
2. 補足事項はすべて注に入れる
FAQ本文を書いたあと、書いた内容を本文に入れるべきかを考えます。FAQ本文から注に移す内容は、 ・「なお、〜」に続く文 ・削ってもFAQ本文が成り立つ文 ・免責事項 問題の解決に何をしたら良いかをシンプルに伝えるために、文はなるべく短い方が良いです。補足事項を読まずとも疑問が解決する可能性もあるので、重要度が下がる内容はなるべく注に持っていきます。
3. ユーザー層に配慮した表現にする
アプリを使うユーザー層にマッチした表現かをチェックしています。例えばモバイルアプリの「ボタン押す」というのは「タップ」なのか「選択」なのかという表現です。スマートフォンをあまり使い慣れていないユーザーも含まれると想定した時は、「選択」の方を使っています。
4. できないことには理由をつける
「〜はできません。」という内容を書く場合、理由をセットで書くようにしています。これは、疑問を解決しに来たFAQで「なんで？」という新たな疑問を生まないようにするためです。理由を書くのは当たり前と思われがちですが、文章をシンプルにして削りすぎるとエンドユーザーに不快な思いをさせることがあるので、気をつけるようにしています。
5. 敬語はほどほどに
FAQ本文は、さっと読んで疑問を解決するのが目的なので、丁寧語に近い文体で書いています。敬語だとどうしても文が長くなってしまうので、使い分けるようにしています。特に問い合わせ返答文で使っている「誠に恐れ入りますが」や「お手数ですが」「お願い申し上げます」という言葉は癖で書いてしまいがちなので意識するようにしています。
まとめ
今回は今日添削していた内容を元にポイントをまとめてみました。FAQ以外にも応用できると思うので、何かドキュメントを書く時の参考になればと思います。
余談ですが、「どうやったら上手に書けますか？」と聞かれて、その場で答えられなかった反省も踏まえて今回のブログを書きました。普段自分が当たり前にやっていることでもきちんと言語化して伝えることができて初めて教えられるようになるのだと実感しています。 質問の返事をブログで返すなんてクラスメソッドっぽい！と密かにしみじみしているのでした。