

効率的なマニュアル作成
| |
マニュアル作成に使える時間は限られているのが通例です。また、製品・システムの開発者あるいはサポート担当者が業務の時間を割いて作成する例も多々あります。停滞・やり直しがない効率的なマニュアル作成であるとともに品質が高い(誤りがなくわかりやすい)マニュアルでなければなりません。 |
陥りやすいマニュアル作成
先に述べたように、知識と手法を把握せず、見出し構成を十分に検討することもなく、さらには流用した書式で書き進めても、“わかりやすい”マニュアルを効率的に作成できる可能性は低いと言えます。
-
十分に準備せずに複数の執筆者で分担すると、さまざまな不統一(文体、用語、段落構成など)が生じるおそれがあります。
-
加えて、作成の途中でマニュアルを作成する際のなんらかの課題に突き当たった際に変則的な解決方法をとってしまうおそれもあります。
-
また、知識を準備せずにいきなり図解を取り入れても、図を作成するのに時間を要するばかりとなる場合があります。
とりわけ、ありがちなのは「機能仕様書」と「流用したサンプル」でマニュアル作成を進める例です。同じ製品であっても「機能仕様書」と「マニュアル」では主旨も読者対象も異なります。
機能仕様書をベースにすること自体を誤りと申し上げるつもりはありません。ただし、見出し構成、文体などを読者の視点に変換しなければ、せっかく労力も報われないおそれがあります。

効率的なマニュアル作成−マニュアル作成に伴う時間−
限られた時間でマニュアルを作成には先に述べたように“短時間で済む準備”を怠らないことです。
「マニュアル作成に必要なテクニカルライティングの知識と手法」を通して知ること自体は一度ですみます。基本と手法を把握しておけば見出し構成もさほど時間をかけずに検討できます。
結局、準備がすべてです。工程の見通しをつけやすくなり、マニュアル作成の途中で製品の仕様に変更があっても余裕のある対応が可能になります。

次ページに進む(ボタンをクリックしてください)

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