外注さん向けのシステム使用マニュアルを作っています。私は、マニュアルというのは読めばわかるようになっていないと失敗作だと思っています。家電製品のマニュアルとか見れば、本当に詳細に書いてあります。ま、基本的にマニュアルは見ないで使いますが。
ソフトなどのマニュアルは、分厚いだけでどこを見ればいいのかわからないものが結構あります。昔のWordとかExcelとか・・・。そんなマニュアルでは、外注さんが作業できないので、やることで引けるような目次にしています。
が、何も知らない新規の外注さんだと、事細かに作業内容を図入りで作らないといけないですし、疑問が発生した時に読めばわかるようなものにしないといけません。いちいち聞かれても困りますしね。
などと、考えていたら、どんどんページが増えていって。例外的な処理とかも書いていたら昔のマニュアルみたいになりそうです。どのあたりで止めるべきなのか・・・。