|
テクニカルライティングは、マニュアル作成の効率化にも有効です。適切な準備と手順で進めれば、執筆の停滞あるいはやり直しがなくなるとともノウハウの蓄積にもつながります。 |
まず、当サイトの各コーナーご覧いただくあるいは当社の出張開催セミナーをご実施いただき「マニュアル作成に必要なテクニカルライティングの知識と手法」を知っていただくことを薦めます。
テクニカルライティングの知識と手法を知っていただければ、既存のマニュアルあるいは参考にするマニュアルが「なぜわかりやすいのか」あるいは「なせわかりづらいのか」 を分析でき、どのようなマニュアルを作成すべきかのプラン作りにつながります。
「最初に知識と手法を把握して進める」のと「分析せずにサンプルを流用する」のでは、作成に要する時間もマニュアルのわかりやすさと品質もおのずと違ってきます。 分析を欠いた流用では、いずれ行き詰まったり無理がある解決方法を取らざるをえなくなるおそれがあります。
“わかりやすそうな”マニュアルの書式・文体を流用しても、これから作成しようとするマニュアルに不向きかもしれません。また、取り入れないほうが望ましい部分があるかもしれません。
マニュアル作成でもっとも重要なステップは、「見出し構成の検討」です。見出し構成は、マニュアルのフレームワーク（骨組み）です。最初に章−節−項の各見出しランクと見出し名まで検討しておけば、完成形をイメージしてマニュアル作成を進めれらます。また、見出し構成に沿って数人で分担すれば、執筆を迅速化できます。
見出し名は、それに続く段落の「主題」です。「主題」を明確にすれば、段落の「要点」も引き出しやすくかつ明確になります。見出し構成の検討は、執筆以降の工程に 大きな影響を及ぼします。
「マニュアル作成に必要なテクニカルライティングの知識と手法」を知っていただいたうえで、これから作成するマニュアル用に「見本ページ（＋留意事項）」、「チェック項目」、「執筆要領・用語抜粋」を用意していただくこと薦めます。先の「見出し構成」とあわせてマニュアルの「仕様書」ともよべる文書がそろうことになります。
ここでの「見本ページ」とは、なんらのマニュアルを流用してくる主旨のサンプルではありません。当該のマニュアル用にワープロなどで作成した数ページ分の「見本（プロトタイプ）」です。
「仕様書」化できるのは「これから作成するマニュアル用の知識」です。手法まで仕様書化しようとすると、それだけでかなりの労力を要します。執筆中になんらかの課題に遭遇したらその都度、当サイトの各コーナーご覧いただくかあるいはマニュアル作成に先立って当社の出張開催セミナーを ご実施いただくことを薦めます。
次ページに進む（ボタンをクリックしてください）マニュアルを作成する際の基本をお伝えして、テクニカルライティングへの関心をおもちいただくのが当コーナーの主旨です。
当コーナーの内容を各種の文書作成の参考にしていただくことは作者の意とするところであり、これが皆様のお役に立てば誠に幸いです。ただし、内容の一部あるいは全部の転載（他のWebサイトや他の出版物、等に収録・再配布する） および当著作物の二次使用を禁じます。
上記の主旨より、当コーナーはご覧いただいた方々に議論を呈することを目的としておりません。当社のテクニカルライティングセミナー、文書改善研修およびコンサルティングに関するお問合せ以外には、お答えいたしかねる場合がありますのであらかじめご了承ください。
実践テクニカルライティングセミナー
マニュアル作成の進め方とわかりやすいマニュアルのポイント
Copyright: Takaaki-YAMANOUCHI/1995-2020
山之内孝明／有限会社 山之内総合研究所
Takaaki Yamanouchi/ Yamanouchi Research Institute, Ltd.