「マニュアルを作成したいけれど、何から手を付けていいかわからない」という声をよく耳にします。
いきなり執筆作業を始めてしまって、途中で挫折してしまった、という方もいらっしゃるのではないでしょうか。
マニュアルの作成には、執筆作業以外にも重要な工程があります。
今回は、製品の取扱説明書を新規で作成する場合を例に、マニュアル作成の標準的な流れをご紹介します。
皆さんのマニュアル作成でも、今回ご紹介するような工程が踏めているかチェックしてみてください。
マニュアル新規作成に必要な工程
今回は例として、製品の取扱説明書を新規作成する場合を想定し、最低限発生する工程を順にご紹介します。
1. 企画
まずは、作成したいマニュアルの概要を決めます。
今回の場合は、例えば以下のような内容を確認します。
- 対象製品は？
作成したいのは「A製品の取扱説明書」でしょうか、それとも「Aシリーズ（A製品、B製品…）の取扱説明書」でしょうか。まずは対象とする製品の範囲を明確に決めましょう。
製品のバージョンが複数ある場合は、どのバージョンを基準にするかも決めておく必要があります。
- 用途は？
「取扱説明書」といっても、様々な用途が考えられます。例えば、作成したい取扱説明書は社内で使用する製品の取扱を示すものでしょうか、それとも製品とあわせてお客様に出荷するものでしょうか。用途によって、ふさわしい表現や記載内容が変わるため注意が必要です。
対象とする製品の使い方とあわせ、マニュアルの用途を明確にしましょう。
- 対象読者は？
作成した取扱説明書を読むのは、ベテランの作業者でしょうか、それとも新人でしょうか。読者にあわせたレベル感の内容を記載することで、より使いやすいマニュアルとすることができます。
作成後に製品とあわせて海外に輸出され、海外の作業者が読む場合は、外国語への翻訳が必要かもしれません。その場合は翻訳も意識した工程の組み立てが必要になってくるため、執筆作業を開始する前に予定を確認できると良いでしょう。
- 使用方法は？
ここでは、マニュアルを作成した後に、実際に使用する場面を想像してみます。
読者は紙のマニュアルを使用するでしょうか、それとも画面に表示させて使用するでしょうか。使用する際は画面上で閲覧する想定でも、認証等の関係で紙が必要な場合もあるため注意が必要です。
使用方法にあわせたデータ形式を選択し、執筆・編集作業を行っていきます。
2. 目次構成の作成
本文を執筆する前に、マニュアル全体の目次構成を作成します。
いきなり本文の執筆を始めてしまうと、全体の統一が取れなくなったり、途中で仕様が変わって修正が発生したり、必要な情報の漏れや重複が発生したりすることが多いです。
最初に目次を作成し、全体の方針を固めることで、その後の執筆作業で不統一が出ることを防ぎ、執筆作業自体もより進めやすくなります。
3. 本文下書き、必要な情報の準備
実際に執筆作業を行う前に、製品の仕様を設計書等でよく確認し、まずは下書きを行います。
作成した目次に沿って、ざっくりと下書きを行いつつ、不足している情報がないか確認しましょう。必要な情報が足りていない場合、不明点が残る場合は情報収集を行います。
4. 写真、画面ショットの撮影
取扱説明書に製品の写真や画面ショットを入れたい場合は、可能な限り本文の執筆前に撮影を行います。先に写真や画面ショットを準備することで、その内容を見ながら、辻褄が合うように本文の執筆を進めることができます。
5. 本文の執筆
ここまでで集めた情報を元に、本文の執筆を行います。
なお、読みやすく、正しく伝わる文章を作成するには、テクニカルライティングの技術が必要です。別の記事で紹介しているような、日本語ライティングの注意点も参考にしてみてください。
6. 図・イラスト作成、DTP編集（レイアウト調整）
説明内容に補足が必要な場合は、必要に応じて図やイラストを作成します。
図やイラストを多用すると、かえって説明内容が伝わりにくくなる場合もあるため、特にテキストだと伝わりにくいポイントに絞って作成することをお勧めします。
材料が揃ったら、執筆した本文と、撮影した写真・画面ショット、作成した図・イラストをすべて組み合わせ、使いやすいようにレイアウトを調整します。
スタイル・レイアウトは取扱説明書全体で統一することで、余計な情報が減り、説明したい内容がより伝わりやすくなります。
ここまでの工程がすべて完了したら、マニュアルは完成です。
場合によっては承認を経たうえで、マニュアルを実際に使用する段階に入ります。
こんなときはどうする？
マニュアル作成の工程をざっとご紹介しました。
ここでは、実際にマニュアルを作成しようと思ったときに、多くの方がつまずくポイントをご紹介します。
1. 製品の仕様が未確定、でも執筆を始めないと間に合わない！
本来はマニュアルの作成も考慮した開発・出荷スケジュールを置きたいところですが、製品開発の遅れや出荷スケジュールの都合上、製品が完成してからマニュアルの作成までに十分な時間が取れないこともよくあります。
そんなときは特に、最初に目次構成を作成することが重要です。
全体の構成さえ決まっていれば、あとはどこから書き始めても構いません。執筆に必要な情報が比較的固まっている箇所から書き始め、細かい部分は後追いで反映し、最後に通し読みをしてチェックすると良いでしょう。
2. 自分が執筆したマニュアルで、うまく内容が伝わっているか不安……
マニュアルの執筆は、いざ着手してみると想像以上に難しいものです。日本語の表現には様々な可能性があるため、自分が選んだ用語・表現がふさわしいものになっているか、だんだん不安になってくることも多いはずです。
社内でのマニュアル作成にこだわる場合は、最初は数ページ執筆した段階で、他の方に一度読んでもらい、伝わる内容になっているかチェックしてもらうと良いでしょう。特に操作手順なら、あまり操作に詳しくない人に執筆したものを渡し、実際に読みながら操作してもらうと、その人が迷ったり間違えたりした箇所を確認できるので、不足している情報を洗い出すことができます。
なお、執筆作業を専門のライターや業者に依頼すれば、伝わる文章になっているか、という不安を持つ必要はなくなります。執筆料金はかかりますが、社内での工数を減らすことができ、一定の品質も期待できるため、予算に余裕があれば専門のライター・業者に依頼してしまうのがお勧めです。
まとめ
マニュアル作成の大まかな流れをご紹介しました。もちろん、対象の製品やマニュアルの内容、その他の状況によっても必要な工程は大きく異なるため、実際の状況にあわせた工程を組み立てる必要があります。
ご紹介した工程の中でも、特に最初の企画の部分がマニュアルの質を大きく左右します。これからマニュアルを作成する方は、まずは企画の段階で、方針をしっかり固めてから実際の作成に入るようにしましょう。
この記事を書いた人
編集部 Y
この記事をシェアする
