takazoomのブログ

2017年秋からカスタマーサクセスに取り組んでます。気づいたことを殴り書き。

ヘルプ記事を書く技術

ヘルプ記事の目的は、ユーザの行動を変容させ機能の利用を促進させることである。私がヘルプ記事を執筆・編集する際、目的達成のために配慮しているポイントをまとめておく。あなたのヘルプ記事作成の参考になれば(-m-)

なお、ヘルプ記事には2種類ある。1つは機能の辞書で、もう1つはユースケースを紹介した記事。書き方は異なる部分があるが目的は同じなので、抑えるべきポイントも同じである。

目次

行動を促す記事構成にする

[準備]ユーザーを知る

対話を重ねユーザーの視点に立つことで、行動を促す文章が書ける。対話をしていない場合、ユーザー像が曖昧になるので行動を促す文章は書けない。

また単に対話をしたからといって、ユーザー視点に立てるわけでもない。必要な情報を引き出すためにはインタビューの技術も必要(カンムでマーケティングチームがやってるユーザーインタビューが参考になる)。

[心構え]ユーザー体験全体を考える

ヘルプだけを考えるのではなくユーザー体験全体を通して、目的達成できる手段を考える。そのため、ヘルプ作成と併せて以下も行ったほうがよい。

  • アプリからヘルプ記事へのリンク設置の検討
  • そのリンクの位置・ラベル(文言)の作成
  • エラーメッセージの作成
  • ヘルプで解決できな状況であれば、機能やUIの改善を提案

これらを行うためには、自分で機能を利用することが必須となる。機能が開発中の場合、エンジニアに相談して開発途中の状態でもいいから機能を利用する。

[タイトル]効果を盛り込む

ユーザーを動かすため、タイトルに効果を盛り込む。特にユースケースを紹介するヘルプ記事では、タイトルで効果を謳いたい。

  • NG:□□の機能の説明
  • Good:□□の機能で、〇〇を効率化しよう

〇〇の効率化に興味のないユーザーは記事を読まなくなるので、ユーザーの時間を浪費せずに済むようにもなる。

[リード文]ユーザーのシチュエーションを書く

シチュエーションを書くようにすれば、自然とメリットを伝えることができる。機能を主語にするのではなく、ユーザーの状況に重きをおいた文章にする(営業トークと同じ考えである)。

  • NG:△△や△△ができる機能です。
  • Good:〇〇や〇〇の際に便利な機能です。

[本文]自信を持って言い切る

特定状況下の一人に対して伝えようにすると、言い切ることができる。似たような状況の複数人に伝えようとすると、断言できない。結果、誰にも伝わらない文章になる。

  • NG:できるだけ登録しましょう。
  • Good:登録しましょう。

言い切るために、ペルソナを設定しておくとよい。設定してあると他人に記事をレビューしてもらう際にも役立つ。

全文は読まれない、という前提に立つ

多くのユーザーは全文を読まないので、読まれない前提で記事を作成する。具体的には、以下の点に気をつける。

拾い読みで理解できるようにする

見出しと図版・太字だけで拾い読みできるようにする。ブラウザをさっとスクロールして雰囲気が伝わるようにする。

また、長い記事の場合は、記事の先頭に目次を設置する。ユーザーが、目次で記事の要否を判断できれば、ユーザーに無駄な時間を過ごさせずに済む。

書きすぎない

何から何まで説明しようとしない。読んでくれれば理解してもらえる、という考えは誤り。そもそも読まない人が多いから。

「ここは説明しなくても伝わるはず」という部分は思い切って削る。書き手の心理としては、きちんと伝えたいので詳しく書きがちになるが、余白も含めたテキストコミュニケーションに挑戦する。書き手が「ちょっと説明不足かな」と感じる程度でよい。

校正して限界まで短く

以下2つの観点で文章を短くする。初稿は冗長になりがちだが、気にせず一通り書いたあと「翌日に」校正するのがよい(コスパよく校正できる)。また、短縮可能なテキストをまとめてチートシートを作成するのもオススメ。

(1)カットしても意味が通じる単語は、カットする  (2)短い表現に置き換える  はてなブログの不具合?で、改行が効いていません。

  • 基本的な、基本的には

    • NG:□□や□□といった基本的な操作が可能です。
    • Good:□□や□□といった操作が可能です。
  • このページでは

    • NG:このページでは、□□のコツをお伝えします。
    • Good:□□のコツをお伝えします。
  • することができます。

    • NG:□□をすることができます。
    • Good:□□できます。
  • するように

    • NG:□□を必ず記入するようにしてください。
    • Good:□□を必ず記入してください。

読みやすい文章を書く

長い修飾語を先に書く

これは、<新版>日本語の作文技術の中で紹介されている技術である。様々な書籍を読んだが、その中で一番効果が見込めるテクニック。誰でもかんたんに実践でき、読みやすさが格段にアップする。

  • NG:□□を活用し「メンバーに」「プロジェクトの目的を」伝えましょう。
  • Good:□□を活用し「プロジェクトの目的を」「メンバーに」伝えましょう。

一度英訳して日本語に戻す

あるプロジェクトで、英語のヘルプも用意する必要があった。記事を英訳※する際に、日本語記事の曖昧な記述に気づくことができた。例えば主語が無かったり、文章を分けたほうが読みやすくなったりすることに気づく。

もしあなたが文章のブラッシュアップ方法に行き詰まりを感じていれば、飛び道具的な感覚で試していただきたい。

※私の英訳では不十分なので、海外メンバーに正しい英語にアップデートしてもらい記事を公開していました。

---サムネ用    f:id:takazoom:20200823145642j:plain