マニュアル作成を担当していると、
- 書いた内容が伝わらない
- 何が悪いのかわからない
- どんなことに気を付けて書いたらいい?
こんな悩みが出てきますよね。
この記事では、マニュアルを書くときに内容として入れておきたいポイントをまとめました。
現在、マニュアルの作成担当になってから7年経ちますが、マニュアル作成を担当しはじめたときに、欲しかったなーと思う情報をお伝えします。
スポンサーリンク
マニュアルには手順を説明する前に「何で」「何が」を書く
設定なら「何で」、
機能なら「何が」、
を書いてあげるだけで、ぐっと意味が伝わります。
これは日頃、マニュアルの仕上がり確認する人に言われていたことなんです。
自分だと内容がわかっているんで、
ついついすっ飛ばしてしまいますが、マニュアル読む人知らないことです。
設定なら「何で」、機能なら「何が」を書くことを意識するだけで、
マニュアルの分かりやすさがグッとレベルアップします。