操作マニュアルの作成ポイント
ユーザー(読者)が操作マニュアルを開くのは、たいていその製品やサービスを初めて利用する場合です。その際にユーザーが思っていることは「早く使いたい!」ではないでしょうか。
操作マニュアルの目的はまさしく「ユーザーが早く製品(サービス)を使えるように情報を提供すること」です。それを実現するためのポイントを以下に説明します。
1.情報の正確性
最も重要なことは、マニュアルに記載されている情報が正しいことです。
当たり前のことなのですが、マニュアルは製品の開発と並行して作成するため、開発途中の仕様変更がマニュアルに反映されないおそれがあります。それを防ぐために、ライターは徹底的に自分の目と耳で確認しなければなりません。
- 仕様書などの資料の読み込み
- 開発者への取材
- 仕様変更ごとの実機確認
そして、ライターはテストユーザーでもあります。マニュアルに記述する内容を検証する過程で気がついたことを開発者にフィードバックして、不具合の修正、ユーザーインターフェースなどの改善につながる場合もあります。
2.検索性
ユーザーが目的の情報にすぐに辿り着けるように「検索」のしくみを用意します。
目次構成はユーザーにとって合理的で、かつ内容を推測しやすい項目タイトルにします。他にも、索引、ヘッダー/フッター、ツメなど、マニュアルのページ数や構成に応じて、様々な方法でユーザーが情報を探しやすいように配慮します。
また、利用シーンによってはHTMLやPDFなどマニュアルを電子化して、コンピュータの検索機能やハイパーリンクを活用します。
3.わかりやすさ
誰にでもわかりやすいマニュアルを作成します。
- 論理的な話の展開
- 簡潔で正確な文章表現
- 図表化
- 動画や音声の活用