

ステップ1:書式の検討−マニュアルの仕様の決定−
|
製品・システムを開発する際と同様に、マニュアルも最初に基本となる仕様を決定します。なにげなく、「前例と同じ」にしているかもしれません。しかし、前例と同じにすることでノウハウが蓄積されているならば問題がありませんが、わかりづらい書式あるいは非効率な進め方が繰り返されていないか検討してみるのも必要です。 |
「判型」と「改ページにする見出しランク」の検討
書式を検討する際、最初にすべきは「判型」と「改ページにする見出しランク」の検討です。いずれも、読者への“見せ方”のポイントとなります。
「A4判・縦」をマニュアルをはじめ文書の標準としている企業・分野が大勢を占めています。大き目の判型のため大きな図など使いやすいあるいは1ページに手順をおさめやすい利点があります。ただし、マニュアルの使用環境・条件によっては、他の判型あるいは横使いのマニュアルも検討の一つとなります。
先に述べたように、「改ページにする見出しランク」は「解説の基本単位(区切り)」と関係します。読者にとって読みやすい「解説の基本単位」は1〜数ページです。数ページごとに改ページになる見出し構成が“見通しがよく読者に負担がない見出し構成”とも言えます。

第7部 マニュアルに適した文書レイアウトのポイント 第8部 文書書式の選び方と執筆のルール化
「マニュアル執筆キット」の用意
先に述べたマニュアル作成の仕様書に相当する「見本ページ(+留意事項)」、「チェック項目」、「執筆要領・用語抜粋」と「見出し構成」を一括してここでは「マニュアル執筆キット」とよびます。マニュアル執筆キットは一人で執筆する際にも分担して執筆する際にも有効です。
繰り返しになりますが、「マニュアル執筆キット」は仕様書です。マニュアル作成のマニュアルではありません。「マニュアル執筆キット」さえあれば、“いきなり”マニュアルを作成できるとは思われないように願います。

第8部 文書書式の選び方と執筆のルール化 第9部 用字用語の選び方と用例
次ページに進む(ボタンをクリックしてください)

テクニカルライティングセミナー
マニュアル作成の進め方とわかりやすいマニュアルのポイント
Copyright:Takaaki-YAMANOUCHI/2002-2010
山之内孝明/有限会社 山之内総合研究所
Takaaki Yamanouchi/ Yamanouchi Research Institute,Ltd.
takaaki@yamanouchi-yri.com