マニュアルはシステムが完成する前に書け
2011/7/8 金曜日 – 11:22:55啓学出版(今は存在していない)発行のマニュアルバイブル(絶版)という本があります。
啓学出版(今は存在していない)発行のマニュアルバイブル(絶版)という本があります。
この本から学んだことの一部をここに紹介していこうと思います。
自分史を書くということは、長い文章を作成することです。
うまい文章やわかりやすい文章は、文才に恵まれた人だけの特権だと思っていませんか?
もちろん文才に恵まれた人は、うまい文章やわかりやすい文章を書くことができます。
でも、特に文才がなくたって、十分にうまい文章やわかりやすい文章を書くことはできるんです。
ここでは、そのちょっとしたコツを1つずつ紹介していきます。
「マニュアルはシステムが完成する前に書け」とはなんとまあ、強気な宣言でしょう。
マニュアルとはシステムが完成したあとに書くのが楽だと思っていましたから。
開発途中からマニュアルを作り始めると、仕様変更仕様変更の連続で、書いても書いても修正しなくてはなりません。
そんな段階でなく「仕様はfix、あとは量産するだけです」といって試作機と仕様書を渡される方がずっと楽です。
しかし、マニュアルバイブルはそんな目先にとらわれた、ただ楽をしたいだけのバイブルではないのです。
お客様と製造者の真の幸福を目指すバイブルなのです。
システムが完成する前にマニュアルを書くメリットは、下記です。
テクニカルライターが手順を説明する。
その説明する手順が分かりにくいなら、システムそのものを仕様変更すべきである。
実行ボタンと取り消しボタンが隣り合っていて、つい間違えて押しがちなら、実行ボタンと取り消しボタンの配置を換えるべきなのです。
決まり切った操作をするために、ボタンを20回クリックするくらいなら、専用のボタンを用意すべきなのです。