|
製品・システムを開発する際と同様に、マニュアルも最初に基本となる仕様を決定します。なにげなく、「前例と同じ」にされているかもしれません。しかし、前例と同じにすることで、読みづらい書式あるいは非効率な進め方が繰り返されていないか検討してみるのも必要です。 |
書式を検討する際、最初にすべきは「判型」と「改ページにする見出しランク」の検討です。いずれも、読者への“見せ方”のポイントとなります。
「判型」とは、ご存じのように文書の大きさ（A4判、B5判など）です。「改ページ」とは、見出しの前でページを改めて区切りを明確にする手法です。どの見出しランクで改ページ にするかによって 、「解説の基本単位（独立性がある解説の区切り）」をどの見出しランクに置くかが決まります。
「A4判・縦」を文書（マニュアルを含む）の標準にしている企業・分野が大勢を占めています。大きな図・表を入れやすいあるいは手順を1ページにおさめやすいなどの利点があります。ただし、マニュアルの使用環境・条件によっては、他の判型あるいは横使いのマニュアルも検討の対象になります。
PDFファイルでの配布・閲覧を前提としたマニュアルでは、「B5判・横」にして画面におさまりやすくする事例もあります。判型は後から変更しづらいため十分に検討する必要があります。
先に述べたように、「改ページにする見出しランク」は「解説の基本単位」と関係します。読者にとって読みやすい「解説の基本単位」は1〜数ページです。数ページごとに改ページになる見出し構成が、“見通しがよ く読者に負担がない”見出し構成とも言えます。
一般的にページ数が少ないマニュアルでは、章で改ページにします。ページ数が多いマニュアルでは節で改ページにします。定めた見出しランク以外では不要に改ページにしないのが原則です。
詳細は割愛しますが、改ページの扱い方は見出し構成を討する際の前提になります。
第7部 マニュアルに適した文書レイアウトのポイント 第8部 文書書式の選び方と執筆のルール化
先に述べたマニュアル作成の仕様書に相当する「見本ページ（＋留意事項）」、「チェック項目」、「執筆要領・用語抜粋」と「見出し構成」を一括してここでは「マニュアル執筆キット」とよびます。マニュアル執筆キットは一人で執筆する際にも分担して執筆する際にも有効です。
執筆要領と見本ページに沿ったワープロの「書式ファイル」を用意しておくと、執筆の際に便利です。見出し、段落だけでなく箇条書き、注記などもワープロの「書式・スタイル機能」で設定しておけば、書式の統一が図れるとともに執筆が効率化します。
繰り返しになりますが、「マニュアル執筆キット」は製品を開発する際の仕様書に相当します。マニュアル作成のマニュアルではありません。「マニュアル執筆キット」さえあれば、“いきなり”マニュアルを作成できるとは思われないように願います。
もちろん、数回のマニュアル作成を通して執筆者にノウハウが蓄積されれば、仕様書である「マニュアル執筆キット」があればマニュアル作成を進められます。
|
上記の主旨により、当社ではコンサルティングおよびセミナー以外で「マニュアル執筆キット（テンプレート見本版）」の配布を実施しておりません。 |
第8部 文書書式の選び方と執筆のルール化 第9部 用字用語の選び方と用例
次ページに進む（ボタンをクリックしてください）
実践テクニカルライティングセミナー
マニュアル作成の進め方とわかりやすいマニュアルのポイント
Copyright: Takaaki-YAMANOUCHI/1995-2020
山之内孝明／有限会社 山之内総合研究所
Takaaki Yamanouchi/ Yamanouchi Research Institute, Ltd.