マニュアルの作り方
ちょっと仕事上で文書を書かなければいけなくなって、試しに手に取ってみた
業務システムのためのユーザーマニュアル作成ガイド
posted with amazlet at 10.01.11
おすすめ度の平均: 
システムを活かしてもらうユーザーマニュアルの作り方目次
- 第1章 マニュアル作成の「間違った常識」
- 第2章 マニュアルの企画はこう進める
- 第3章 マニュアルの文章はこう書く
- 第4章 マニュアルや仕様書をわかりやすくするビジュアル表現
- 第5章 マニュアルの校正・表現の校正はこう進める
- 第6章 マニュアルの保守管理はこうする
- 第7章 部品化と構造化で効率アップ
理系の人間が書いた文章…と言ってしまうと範囲が大きくなりすぎてしまうからそういう区分けができるとは限らないが、多くの場合は″読みづらい″とされてしまう。特に物の説明に関する文書ではそれが顕著になるのではないだろうか。
本書では、いわゆる”物の書き方”としてぱっと思いつく内容に関してそれって違うんじゃない？って感じで紹介してある。特に、"マニュアル"という種類の文書を書くときに限定しているので、全部の文書に適用できるわけじゃない。逆を言うと、それぞれの目的にあった書き方をちゃんと意識しなければいけないということだ。
たぶん、そこがずれている。
ものづくりをする人間で陥ってしまう過ちとしていつもやり玉に挙げられるのが「作りたいものを作る」のではなく「使ってもらえるものを作る」ということの重要性。
それは文書においても同じで、読み手が何を目的にその文書を手に取るのか。また、手に取ってほしいのかを意識しながら書かなければいけない。
時には、マニュアルだけではなく様々な文書の中で「これはこの目的で」「それはその目的で」というような住み分けのようなものが必要になるんだろう。
一方で、目的別に書きすぎると重複する内容が生まれてしまうことも忘れてはいけない。
あまりに重複してしまうと、変更時の保守が大変になるし漏れも発生することになる。それを防ぐためには文書の中に別文書を参照させるような記述をすればよいのだがあまりに参照ばかりでは結局読みづらくて本来の目的を達成できなくなってしまう。
このあたりのバランスをしっかりと見定める必要があると思う。
また、そもそも文書を誰が管理するのか？どう管理するのか？ということに関して明確にしておくことも大事だ。特に、これは事前に決めておかないとあっという間に中途半端な文書のパラダイスが生まれてしまい、収拾がつかなくなる。
開発者は文書を軽視する傾向がある。それは、文書が必要な場面というものは今ではなく数年先だったりするし、そもそも必要とするのは自分ではなくほかの人だったりする。そこが、今文書を作ることに対しての足かせとなってさらには保守されない文書を生むのだろう。
この状況を打破するためにはどうしたらいいだろうか。
やはり意識改革なのか・・・。こればっかりは人と人。そして人の中の考え方。
一つの答えですっぱりと割り切れるものはないのかもしれないなぁ
