わかりやすいマニュアル作成方法

実際マニュアルを作成する立場になって、必要・不必要な情報の選別、構成、図の使い方など、効果的なマニュアル作成がいかに難しいか知るようになりました。
参考になるURLや作り方のコツなど教えてください。
わかりやすければジャンルは問いません（技術者向け、一般向け等）。
よろしくお願いいたします。

No.3 ベストアンサー 回答者： maisonflora 回答日時： 2003/03/17 15:05

当社では、基本形を作っています。

Ａ４用紙タテです。
１．表紙：マニュアル名、作成年月、作成部門、目次・ページ
２．はじめに：管理職のマニュアルなど役割を表示する場合だけ
３．フローチャート：Ａ３用紙１枚に、そのマニュアル全体のフローチャートをつけます。上下３分割し、上から他部署、真中は自部門、下は業者。左から右へ時間の経過とともに、やるべきことを図示します。
４．業務フロー：項目ごとに、Ａ４タテで、左から、目的、内容、書類、と３分割し、業務の流れを記入します。項目とは、採用マニュアルなら、広告、面接、書類選考、内定書類、などのことを示します。このＡ４の下には、この業務のポイント・注意点を短い言葉で書いています。
５．説明：説明部分を記載します。
６．連絡先・手配先一覧表

この回答へのお礼

箇条書きでわかりやすかったです。
ありがとうございました。

お礼日時：2003/03/17 16:39

No.4 回答者： noname#6248 回答日時： 2003/03/17 15:20

取扱説明書ではないですが。

「あまりに多機能にするとかえって不便になる」これはものつくりには大切なことなんですね。
相変わらず無意味なヘルプ、無駄に鮮やかなフレーム、学習機能はあるのに忘却機能の無い日本語入力システム…使えんな…ほんと、イルカが憎い今日この頃。

えっと、私なりのポイントは「使う人が何をしたいか」を考えながら書くことですかね。
「したい行動がどういう言葉か知らない」これを前提に書くと判りやすいです。
それに習い実際作るソフトもわかり易くはならないんでしょうかね…
「動詞を主にして書く」と言うのも良い方法かと思います。
すべてを知っている人が手順通りに書く仕様書。それを元に作る取扱説明書。だから判らんのです。
もしも漢字字典が「学校で習う順」に並んでいたら調べやすいはずがないですよね？

書式→フォント→下線を引く
飾る→文字→下線を引く
どちらの方が判りやすいか…(私なんかは下かと思うんですが…)
改ページが挿入の中って想像しがたいですし。
Ｆ１キーで現れる使えないヘルプ…何とかならんのかって思いますからね…
判りやすい説明書の前に判りやすいシステム…実はこれが一番だったりして…

参考URL：http://www.laplace-lab.org/index.shtml

この回答へのお礼

具体例がわかりやすかったです。
参考URLいいですね。
とても勉強になります。

お礼日時：2003/03/17 16:40

No.2 回答者： youyou2 回答日時： 2003/03/17 13:58

なんのマニュアルを作るかにようるかですが、ポイントは

プロセスに沿って、自分がマニュアルを利用する立場になり、いかに漏れなくダブりなく作成するかですね。

完成したら、自分にはバイアスが掛かっているので全く第３者にに読んでもらうのがいいでしょう。　

この回答へのお礼

>自分がマニュアルを利用する立場になり、いかに漏れなくダブりなく作成 するかですね。

ダブりも時として必要なんですよね。
しつこく出てくると内容が薄くなりますが。

>自分にはバイアスが掛かっているので全く第３者にに読んでもらうのがいいで しょう。

そうですね。ありがとうございます。

お礼日時：2003/03/17 16:37

No.1 回答者： 9766 回答日時： 2003/03/17 13:55

コツを。

（経験から。）
１、同じ物の名称・名前が変わってはいけない！
例）このマニュアルでは・・・。
　　当該説明書の・・・。
　　リファレンス後半につづく・・・。
２、「どこどこを参照って、行ってみると元を参照」ってことのないように！

この回答へのお礼

基本ですね。
ありがとうございます。

お礼日時：2003/03/17 16:33