マニュアルには「文章」を書くな

 今回はマニュアルの書き方についてのお話です。

マニュアルの書き方って難しいですよね。何が難しいかって、「製品のことをよく知っている人が、何も知らない人にもわかるように書かないといけない」ということです。つい専門用語を使ってしまうこともあります。

今回は、マニュアルを書くときに気をつけるべきことについてです。

読む人の前提知識を正確に想定する

まずやるべきことはコレ。

もっとわかりやすく言うと、「このマニュアルを読む人（製品を使う人）は何を知っていて何を知らないのか？」ということです。これは「何をどこまで説明するのか、そして何を説明しないのか？」を定義することにつながります。

例えば家電のマニュアルの場合、何も知らない人が読む（使う）ことを想定して、手順を本当に細かく説明していると思います。

一方で、例えばGitHubのユーザーマニュアルは「Gitの使い方を知っているソフトウェア開発者しか使わない」という前提で、Gitの使い方やブランチなどの用語については知っているものとして完全に省略しています。

このように、まずは「どんな前提知識を持った人が使うのか？」をしっかりと想定しましょう。

さらに言うなら、読者の前提知識が何であれ、マニュアルを読む人は

• 必ずしも読解力が高いわけではない（文章をこちらの意図通り理解できるとは限らない）
• 必ずしも最初から最後まですべて目を通してから操作するわけではない

という点は常に頭に入れておきましょう。

「利用者が行うべきこと」と「製品の反応」を明確に分ける

たとえばウェブサービスのマニュアルで「ここに電話番号を入力します」と書いてあったら、誰が電話番号を入力すると思いますか？

そりゃもちろん利用者ですよね。

本当に？？

サービス運営会社の電話番号が自動的に入力されるんじゃなくて？

普通に読めば利用者が入力すると解釈できますが、ここで言いたいのは上で書いたとおり「必ずしも読者の読解力が高いわけではない」ということです。あるいは、慌てて読んで内容を吟味せず表面的な文法だけ撫でたために変な解釈をしてしまうことがあるかもしれません。

この場合、「入力します」ではなく「入力してください」と書けば利用者が入力するということが明確にわかります。細かい表現の違いだけでわかりやすさが大きく変わることがあるので、できるだけ明確な表現を使いましょう。

図解する

これは言うまでもありませんね。「百聞は一見に如かず」ということわざがあるように、言葉より図のほうが格段に伝わりやすいです。

このとき気をつけなければいけないのは、製品の外観やインターフェースや変わったら図も差し替えるということです。当たり前の話なんですが、特にウェブサービスは頻繁にUIが変わることがあるのでマニュアルを忘れずに対応させるのはかなり大変です。しかし、きちんと図も差し替えておかないと見る人が混乱します。

特にコンピューターが苦手な人は、ちょっとダイアログ内の表現が違うだけでも「え、マニュアルと違うけど本当にこの操作してもいいの？」と不安になることがあります。

文章を書かない

何のことかというと、「あれをした後でこれをして、ああなったらそれをしてください」のように、行ってほしい操作を文章で書くととても分かりづらいという意味です。

1. あれをしてください。
2. これをしてください。
3. ああなったら4に進んでください。ならなかったら完了です。
4. それをしてください。

のように、読みながら操作できるよう短く箇条書きでまとめましょう。

特に条件分岐が入るときは、条件を満たさなかったら何をすべきかも書くとよりわかりやすくなります。

マニュアルを書くときはだいたいこのあたりに気をつけています。みなさんもよろしければ参考にどうぞ。