見出し構成の検討段階から執筆はすでに始まっています。見出し名は段落の「主題」です。主題が不明確では、要点となる文章も導きだされません。見出し構成(見出し名を含む)を効率よく的確に検討できるかが 、マニュアル作成全体の効率にも大きく影響します。 |
見出し構成は、上位の見出しランクから検討を進めるのが基本です。章−節−項(必要に応じさらに1ランク)の階層で見出しを構成します。
この際、不要に見出しを細分した構成とせず、先に述べた「解説の基本単位」を中心にして見出しを構成するのがポイントです。
新規にマニュアルを作成する際は、キーワードに沿って「見出し要素の抽出」から始めるのが適当です。
いったん見出し構成ができても、それは“仮の見出し構成”にすぎません。必ず、順序あるいは偏りの有無などを見直すための調整を行ってください。あわせて、同格の見出しランク、上位−下位の見出しランクの見出し名も見直してください。
この見出し構成を調整する手法は、製品・システムの仕様変更に応じてマニュアルを改訂する際にも役立ちます。
第1部 見出し構成と見出し名の考え方
見出し構成を検討する際は、ワープロ(あるいはDTPソフト)のアウトラインプロセッサ機能が便利です。見出しランクの変更あるいは順序の入れ替え、見出しの追加が容易にできます。また、何よりも見出し構成を“俯瞰(ふかん)”して確認できる利点があります。
しばしば、マニュアルを作成する際にワープロあるいはアウトラインプロセッサ機能が付いたDTPソフト以外のソフトウェア(プレゼンソフト、表計算ソフトなど)を流用する例を見かけますが、非効率に思え ます。
マニュアルのみならず文書作成では、見出し構成の検討はその後の執筆の進め方と大きく関係します。とりわけ、ページ数が多いマニュアルでは、アウトラインプロセッサ機能を有効に使うことを薦めます。
マニュアルの改訂に際して見出しを追加・削除する場合などにも、アウトラインプロセッサ機能と関連する諸機能は非常に便利です。
実践テクニカルライティングセミナー
マニュアル作成の進め方とわかりやすいマニュアルのポイント
Copyright: Takaaki-YAMANOUCHI/1995-2020
山之内孝明/有限会社 山之内総合研究所
Takaaki Yamanouchi/ Yamanouchi Research Institute, Ltd.