一筋縄ではいかないドキュメントの対象読者

高木です。おはようございます。

最近、久しぶりにドキュメント書きに専念しています。
といっても、本を書いているとかではなく仕様書ですけど。

私はドキュメントを書くのは嫌いではありませんし、むしろ好きな方です。
ただ、これまでブログやら、仕様書やら、設計書やら、書籍やらを書いてきて、いつも思うのはドキュメントを書くのは難しいということです。

何が難しいかというと、一番は対象読者の設定です。
目の前にいる相手に説明する場合とは違って、よくわからない人たちを相手にドキュメントを書くのは本当に難しいのです。

ドキュメントは、その目的によって対象読者の立場も異なれば、知識レベルも異なります。
ここをきちんと見極めないと、独りよがりになってしまって、せっかく頑張って書いたドキュメントが役立たずになってしまうことさえあります。

たとえば、ユーザー向けの取扱説明書と、開発者向けの仕様書や設計書と、予算を獲得するための企画書やプレゼン資料では、同じ対象について書いたとしても目的も対象読者も違いますね。

ユーザー向けの取扱説明書であれば、深いところまで正確にわからなくてもいいけれど、素人にもわかりやすく、すぐに使えるようになることを目指すべきでしょう。
開発者向けの仕様書や設計書では、実装時に迷うことがないように、必要な内容を網羅して詳細かつ正確に書かなければ意味がありません。
予算を獲得するための企画書やプレゼン資料では、詳細さや正確さは二の次で、(表現は悪いですが)わかった気にさせて、お金を出す決意をさせるものでなければなりません。

ここを間違うとダメとわかっていても、情報が不足していたり判断を誤ったりして、違う方向に行ってしまうことはよくあります。
いろいろなしがらみがあって、方向性が間違っているとわかっていても軌道修正ができないこともあるでしょう。

本来であれば、詳細かつ正確に書くべきドキュメントであっても、本来対象とすべき読者より上司や顧客に納得してもらうことを優先して、結果プレゼン資料のようになってしまうこともあります。
それで上司や顧客は納得しても、実際にはほとんど役には立ちませんから当然のように現場は混乱します。
上司や顧客からすれば「なぜ、うまくいかないんだ?」ということになるのでしょうね。

読者視点で見ても、入手したドキュメントが今の自分を対象としたものでなければ役に立たなくて困ります。

以前にも書いたかもしれませんが、先日、理由があって地球から火星へ向かう宇宙船の軌道について調べていました。
ホーマン軌道ないしは準ホーマン軌道についてはすぐに行きついたのですが、そこからがなかなかでした。

私が欲しかったのは、地球と火星の公転軌道に関する(私にとって)十分な精度の情報であり、ホーマン軌道を計算するための具体的な計算式でした。
そして、何年何月何日に地球と火星が公転軌道上のどの位置にいるのか、ホーマン軌道を利用するには何年何月何日に地球をどの位置から出発して、何年何月何日に火星にどの位置で到達するのかを算出するために必要な情報だったのです。

しかし、ちょっと探して見つかる情報は、何となくわかった気分にさせる程度の図解が大半でした。
それはそれで価値あるものですが、私にとって、これでは役に立ちません。
火星云々は別にしても、こういう状況は決して少なくないと思います。

ところで、先日、「『教科書が読めない』子どもたち 教育現場から見えた深刻な実情」という記事を読みました。
子供たちは想像以上に文章を理解できていないという内容で、しかも、文章を理解できるかどうかと学力の間には相関関係がないというのです。
文章が理解できなくても問題のパターンを丸暗記すればテストで点は取れてしまうからではないかと分析しています。
確かに、受験に特化したテクニックとして、丸暗記で対応というのはいかにもありそうです。

これは子供だけの話ではなく、大人にも十分あてはまることです。
子供も大人も、決して少なくない割合で文章を理解できていないのだと思います。
そうなると、ドキュメントを書くのはさらに難しくなってきます。

ドキュメントを書くにあたっては、読者が日本語で書かれた文章を読んで理解できることは大前提になっています。
しかし、それができない相手を想定して、図を多用した絵本のようなドキュメントを作ったとしても、多くの場合それでは目的を達成できません。

可能であれば、まともな読解力がある「できる子」だけを相手にしたいのですが、実際にはそうもいきません。
人間の言葉が通じない人たちを相手にどう対応すればいいのか、今後の大きな課題だといえます。