takazoomのブログ

ヘルプ記事の目的は、ユーザの行動を変容させ機能の利用を促進させることである。私がヘルプ記事を執筆・編集する際、目的達成のために配慮しているポイントをまとめておく。あなたのヘルプ記事作成の参考になれば（-m-） なお、ヘルプ記事には2種類ある。1つは機能の辞書で、もう1つはユースケースを紹介した記事。書き方は異なる部分があるが目的は同じなので、抑えるべきポイントも同じである。 目次 行動を促す記事構成にする [準備]ユーザーを知る [心構え]ユーザー体験全体を考える [タイトル]効果を盛り込む [リード文]ユーザーのシチュエーションを書く [本文]自信を持って言い切る 全文は読まれない、という前提に立つ 拾い読みで理解できるようにする 書きすぎない 校正して限界まで短く 読みやすい文章を書く 長い修飾語を先に書く 一度英訳して日本語に戻す 行動を促す記事構成にする [準備]ユーザーを知る 対