|
執筆を効率よく進めるには、見出し構成を検討する段階で明確な見出し名を付けるとともに、見出しに対応した主文（要点を述べる文）と補足文（要点を補足する文）の文体を想定しておくことです。 加えて、陥りやすい文体・表現とその見直し方を把握しておくことです。準備を欠いてワープロに向かって時間を費やすより、書き方とチェックポイントをあらかじめ把握して進めるほうが得策です。 |
見出し構成を十分に検討しておけば、執筆も効率よく進みます。アウトラインプロセッサ機能を使って見出し構成を検討しているならば、「アウトライン表示」から「ページ表示」に切り替えるだけで書式（スタイル）付きの見出しが配置されたページが表示されます。
後は、見出しを受けて段落の最初で要点を述べ、必要に応じて図・表あるいは箇条書き、注記などで補足するだけです。それぞれのまとめ方とポイントは当サイトの各コーナーで解説しています。
必要ならば、執筆の途中でも見出し構成を調整します。見出し構成の検討時では想定できなかった事項（例：ある箇所の解説がきわだって長くなる）が執筆時に表面化し、見出し構成の再調整が必要となる場合があります。
また、見本ページや執筆要領では対応できない事項があった場合は、その結果をマニュアル執筆キットに反映しておくとノウハウの蓄積になります。
第2部 段落構成の考え方と箇条書き、図・表、注記の使い方 第3部 製品の解説と操作手順の表し方 第6部 マニュアルに適した図解の手法
執筆したら必ず見直しが必要です。解説あるいは手順にかかわる事項とともに文体、表現、用語も見直す必要があります。
この際、見直す事項が多すぎると必ず見落としが生じます。最初の段階で見直す事項が少なければ、重要な事項の見落としもなくなり作成に要する時間も短縮できます。
マニュアル作成を効率化する手法として、「チェックポイントを把握して書く」ことを進めます。あらかじめ、“予想される修正”を執筆の際に織り込んでおけば、後からの修正が少なくなります。
書きあげた時点では、いわゆる「ケアレスミスの箇所」と「より適切な表現にすべき箇所」が混在している状態です。見直しの際に「より適切な表現にすべき箇所」に注力すると 、ケアレスミスが残る可能性があります 。
先のマニュアル執筆キットのセクションで述べたように、「チェック項目」をリスト化するとともにその事例と見直し方を把握しておけば、「より適切な表現にすべき箇所」が格段に減ります。その結果、見直しの時間を含めてもマニュアルの作成に要する時間を短縮できますし、品質とわかりやすさも向上します。
「書くだけで精一杯」、「書きながら見直すなど無理」と思われるかもしれません。テクニカルライティングでは、「書く」を効率化するさまざまな手法を提唱しています。また、チェック項目は、数回で“身に付きます”。 さらに、要点を明確にした簡潔な段落で表すことを基本にすれば、「チェックポイントを把握して書く」はけして無理ではありません。
第4部 陥りやすい技術表現の見直し方 第5部 誤解・違和感につながる文の見直し方
次ページに進む（ボタンをクリックしてください）
実践テクニカルライティングセミナー
マニュアル作成の進め方とわかりやすいマニュアルのポイント
Copyright: Takaaki-YAMANOUCHI/1995-2020
山之内孝明／有限会社 山之内総合研究所
Takaaki Yamanouchi/ Yamanouchi Research Institute, Ltd.