ITエンジニアとしてユーザーマニュアルの作成は避けられない作業です。特に未経験からITエンジニアになる人はこのドキュメント作業を見落としている人が数多くいると思います。今回はそのような私が苦手で、嫌いなユーザーマニュアルの作り方を一緒に勉強していきます。
ユーザーマニュアルとは？
ユーザーマニュアルとはエンドユーザーに対して、特定のサービスや製品に対しての使い方のサポートを提供するドキュメントです。
このユーザーマニュアルは紙ベースのものであったり、映像、アプリ、インフォグラフィックなどフォーマットは多岐にわたります。
分かりやすいユーザーマニュアルの作り方
それでは早速ユーザーフレンドリーなマニュアルの作り方を紹介していきます。
プラン
まずは計画からです。
何も考えず作り始めることはしないようにしましょう。
多くの人は製品やサービスのことを理解していれば、ユーザーマニュアルを作り始めることが出来ると考えています。ですが、実際はそんな簡単ではありません。したがって、まずは今から作るドキュメントが本当にユーザーの為になるかどうかを考えましょう。
マニュアルの計画を作るうえで考慮する必要がる内容を下記にまとめました。
- マニュアルに何を含むべきか？
- マニュアルから何を省くべきか？
- 順番はどうするべきか？
- どのようにマニュアルを提供するのか？
- マニュアルの責任者は誰か？
- 翻訳やローカライゼーションが必要かどうか？
このような計画が出来たら、対象の製品やサービスのことをもっと学びましょう。
全てを完璧にマスターする必要はありませんが、少なともハンズオン経験があるとことが望ましいです。使った経験があるのとないのでは雲泥の差がありますね。
ある程度の知識と経験を身に着けたら、マニュアルのフォーマットを考えましょう。
- ワード？
- エクセル？
- パワーポイント？
- PDF？
- html？
- txt?
さらには提出の仕方も考えないといけませんね。プリントアウトするのか、それともオンラインで提出するのかなどです。
どちらか分からない場合はプリントアウトとオンラインバージョンを両方用意しておきましょう。
なるべくPDFにしないようにすることをお勧めします。PDF以外のフォーマットでオンラインで保存しておきましょう。そのほうが後々使いやすいです。
マニュアル作成
ここまでのプランを立てることが出来たら、早速マニュアルを作っていきましょう。
下記の点を意識してマニュアルを作ってみてください。
- 専門用語を避けましょう。
- 略語を避けましょう。
- ユーザーは何も知らない前提で作りましょう。
- 簡単な言葉で説明しましょう。
- 中学生にも伝わる表現で書きましょう。
テスト
作ったマニュアルをテストしてみましょう。
実際に使用するまではマニュアルの問題点には気が付くことはできません。作った人だけが分かるマニュアルでは意味がないですよね。
下記の点に注意しましょう。
- 実際のユーザーに使って貰う。
- フィードバックを最終マニュアルに取り入れる。
- テスターがいない場合は自身でテストする。
マニュアル更新
マニュアルは一度作成したら終わりではありません。
新しい情報やバグ、変更点があれば常にアップデートしていきましょう。マニュアルを最新の状態に保つことでユーザー満足度を保つことが出来ます。
