ドキュメント作成のコツは、正しいことをわかりやすく書くこと
先日知人と話しているときに、「結局どんなドキュメントが一番良いのか？」と言う質問を受けました。
うーむ、としばらく考えたのですが、結論としては『正しいことをわかりやすく書く』かな、と答えました。
こうして改めて文章にすると当たり前のことしか言ってないな、という感じですが。。この当たり前のことができていないのだろうな、という気持ちになりました。
せっかくなのでもう少し深掘りしてみたいと思います。
ドキュメントには４種類ある
ドキュメントには下記の４種類あります。
正しくてわかりやすい
正しいがわかりにくい
正しくないがわかりやすい
正しくないしわかりにくい
簡単にマトリクスにすると以下です。
このマトリクスの、右上の「正しくてわかりやすい」ドキュメントが一番良いです。当たり前ですが。
もちろんドキュメントを書いている人からすると、「正しくてわかりやすい」ドキュメントを書いていると思っています。
しかしながら、意図せず「正しいがわかりにくい」または「正しくないがわかりやすい」に陥ってしまいがちです。
なぜそうなってしまうのか、具体的に考えていきたいと思います。
正しいがわかりにくい
正しければ問題ないのでは？と思いますが、やはりわかりやすい方が良いでし、わかりにくいと変な誤解を与えてしまう可能性もあります。
例えばこちらのチラシ。
ぱっと見ると、チラシを持っていけばリフト一日券をプレゼントしてくれそうに見えます。
しかしながら、文章をよく読むと以下のように書かれています。
このチラシを持っていくと
リフト引換券で
リフト一日券を
プレゼント！！
「リフト引換券で」という文言が入っています。なので、『チラシ+リフト引換券を持っていく』と、リフト一日券をプレゼントしてくれる、ということになります。
文章をよく読めば間違えないのですが、わかりにくさから間違えてしまう方がいそうです。
制作者の意図を汲むとすると、お得感を出したかったのだと思います。しかしながら、チラシさえ持っていけばリフト一日券をもらえると勘違いしていた利用者側からすると、なぜか損した気持ちになってしまうかもしれません。
今回のケースの場合は、単純に、『このチラシを持っていくと、リフト券1000円割引！』のようにわかりやすく書くだけで良いと思います。
念のため注釈
紹介したチラシは、私がCanvaで3分ほどで作成したダミーチラシです。
似たようなチラシを以前もらったのを参考に作りました。
正しくないがわかりやすい
正しくないことは書いてはいけないのは当然なのですが、意図せず書いてしまうこともあります。例えば下記文章。
はい、私もカレー大好きです。。すが、「みんな」は明らかに間違いですよね。こんなツッコミが来ることが想定されます。
ポイントは、特に悪意があったり、騙してやるぞという意味で正しくないことを書いているわけではないのです。なので誰でもこういう内容は書きがちです。
主語に「みんな」や「誰でも」を使うときは注意が必要ですね。
正しくないしわかりにくい
ちょっと無理矢理感ありますが、下記。
ざっと見ただけで下記のような疑問が浮かぶびます。
営業時間は何時なのか
いつまでやっているのか(日付が間違えている)
何時まで問い合わせ可能なのか
問い合わせ方法はメール？電話？
こういう間違いは、チャットやメールの返答に急いでいる時におきがちです。推敲するか、他の人のレビューで解決しますので、落ち着いて読み返せば問題ありません。
正しくてわかりやすい
ということで、正しくてわかりやすい文章を書くように心がけましょう。
正しくてわかりやすい文章を書きたい場合におすすめなのがこちらの本です。
文章を書いている際に、迷ったらこの本で解決できます。おすすめです。
また、最近個人サイトでもまとめているので、こちらもご覧いただけると幸いです。
読んでいただきありがとうございます。